postgres-migrate-cli

postgres-migrate-cli

Migrations tool for PostgreSQL

Install

npm i postgres-migrate-cli

Usage

postgres-migrate-cli [command] [options]

options:
  --table - table name in DB to store migrations. Default is `migrations`
  --config - path to configuration file. Default is `./config.json`
  --path - path to migrations folder. Default is `./migrations`
  --count - count of applied/reverted migrations (only for `up` and 'down' commands)

commands:
  up - apply new migrations. Default command
  down - revert all migrations
  create - create migration file in migrations folder

Config format:

{
  "development": {
    "host": "127.0.0.1",
    "user": "devUser",
    "password": "devPassword",
    "database": "testDB"
  },
  "production": {
    "host": "www.com",
    "user": "prodUser",
    "password": "prodPassword",
    "database": "prodDB"
  }
}

By default used development config. Please use NODE_ENV to switch config

Migration file format

module.exports = {
  up: 'ALTER TABLE my_cool_table ADD COLUMN super_column TEXT;',
  down: 'ALTER TABLE my_cool_table DROP COLUMN super_column;'
}

where up and down is plain SQL:

• up section applies migration
• down section revert migration

In your package.json

You may have some scripts in your package.json:

{
  "devDependencies": {
    "postgres-migrate-cli": "latest",
    "cross-env": "latest"
  },
  "scripts": {
    "migrations:dev": "cross-env NODE_ENV=development postgres-migrate-cli up --table migrationsDev",
    "migrations:prod": "cross-env NODE_ENV=production postgres-migrate-cli",
    "migrations:revert:dev": "postgres-migrate-cli down --count 1 --table migrationsDev",
    "migrations:revert:all": "postgres-migrate-cli down --table migrationsDev",
    "migration:create": "postgres-migrate-cli create"
  }
}