migrate-elephants v0.1.0

migrate-elephants

TLDR;

If you do not like migration tools that force you to have a million migration files, but keeping everying synced without one is a PITA. Then you might like this little tool.

What does it do

migrate-elephants cli takes a path to a SQL file and a Postgres database url. It compares the SQL file to the DB and essentially diffs the two. The idea here is that you have one setup file that is the "source of truth" for your DB. With this tool you can easily check your local, staging, testing and production DBs against the "source of truth"d.

This tool will check types on columns as well as most constraints like UNIQUE and NOT NULL. There are some weird edge cases with bigserial and bigint in pgsql-parser, the parser I used to parse the SQL.

Sample output:

What does it NOT do

Currently this tool only works with Postgres. It also does not support many of the more advanced features of Postgres like triggers, procedures, views, etc. Hopefully this will happen sometime in the near future.

Installation

npm install -g @joe-blow/migrate-elephants

Usage

migrate-elephants --file=path/to/file.sql --database=dburl

If you run migrate-elephants without the --database flag it will check the local folder for a .env file with a DATABASE_URL variable and use it if found. This allows you to use migrate-elephants in your npm scripts and have it default to to the local dev environment.

When connecting to a remote db, make sure to run with the --ssl-on flag.