charperbonaroo/pgmigrate
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
Charper Bonaroo's PostGres Migrate tool
Screw DSLs. Write migrations using plain SQL.
Examples:
cbpgm init
cbpgm recreate
cbpgm migrate
Commands:
recreate Fastest way to start fresh: Drop if exists, then create and migrate
migrate Create database if not exists, then run the `up.sql` files for the
migrations and add them to the list of completed migrations, sorted
naturally. Accepts migration IDs to rollback individual migrations,
otherwise runs all migrations.
up Alias for migrate
rollback Run `down.sql` (if exists) for all migrations executed in the last
`migrate`-call (even if the folder had no `up.sql` file) in reverse
order. Requires migration IDs to rollback individual migrations, or
`--last` to rollback the last migration.
down Alias for rollback
init Create the .cbpgm.js config file & migrations directory
config Print the current postgres config
help Render this help-text
list Print the list of migrations and their status
createdb Create the postgres database (without migrations)
create Alias for createdb
dropdb Delete the postgres database.
drop Alias for dropdb
This tool allows you to write migration scripts in plain SQL. You create your
migration by creating a folder containing a `up.sql` and `down.sql` file. The
migrations (i.e. the `up.sql` files) will be executed in their containing
folder's natural sort order. Migrations will only be executed once unless
they've been rolled back. The `up.sql` and `down.sql` aren't both required, but
one of them should exist. Alternatively, if you only need an `up.sql`, you can
also use an .sql file directly in the migrations root folder. E.g. creating a
`123-foo.sql` file has the same effect as creating a `123-foo/up.sql` file
without a `down.sql` file.
Sorting of migrations is done using a NATURAL ORDER. Natural sorting is the
ordering of strings in alphabetical order, except that multi-digit numbers are
treated atomically, i.e., as if they were a single character.
Example folder structure (naturally sorted):
migrations/
1-add-users/ up.sql down.sql
2-add-posts/ up.sql down.sql
3-add-comments/ up.sql down.sql
12-add-categories.sql
13-add-votes/ up.sql down.sql
101-add-reports/ up.sql down.sql
If you're running this command from the repo, you can use `./cli.js` instead of `cbpgm`.