pgmigrations 0.0.4

SQL migrations for projects using PostgreSQL

pgmigrations

SQL migrations for projects using PostgreSQL

Example Usage

Initialise the migrations

pgmigrations init --dsn <dsn>

or

export PGMIGRATIONS_DSN=<dsn>
pgmigrations init

This will create a directory called migrations and will create a table called pgmigrations in the database to store the migration history.

Create a migration

pgmigrations create --dsn <dsn> <tag>

or

export PGMIGRATIONS_DSN=<dsn>
pgmigrations create <tag>

This will create a skeleton migration in the migrations directory. The migration will consist of a directory with the name <timestamp>_tag, for example 20200701_1030_first_migration , which contains two files; apply.sql and rollback.sql.

As the names suggests, apply.sql will be executed when the migration is applied and rollback.sql will be executed if the migraiton is rollbacked.

Apply migrations

pgmigrations apply --dsn=<dsn>

or

export PGMIGRATIONS_DSN=<dsn>
pgmigrations apply

This will apply any unapplied migrations. Each migration is applied in an atomic transaction.

Rollback a migration

pgmigrations rollback --dsn=<dsn> <name> 

or

export PGMIGRATIONS_DSN=<dsn>
pgmigrations rollback <name>

This will rollback an already applied migration.