migrate db using postgres sql files
Last updated 3 months ago by ikerin .
Apache-2.0 · Repository · Original npm · Tarball · package.json
$ cnpm install @ovotech/pg-sql-migrate 
SYNC missed versions from official npm registry.

Postgres migration tool with plain sql

A very small library for running sql migrations with postgres. It differs from the numerous other libs in this domain by being very minimal, using only raw timestamped sql files. No "down" migrations are provided by design, as that is usually a bad idea in production anyway.

Using with CLI

yarn add @ovotech/pg-sql-migrate

add a configuration file, which by default is ./pg-sql-migrate.config.json to configure the connection:

  "client": "postgresql://postgres:dev-pass@",
  "directory": "migrations",
  "table": "migrations"

The default values for "directory" and "table" configuration is migrations but you can override that if you need to.

Instead of a string you can use an object. This is passed directly to pg https://node-postgres.com/features/connecting

  "client": {
    "user": "postgres",
    "password": "dev-pass",
    "host": "",
    "database": "postgres",
    "port": 5432

To create new migrations in the designated directory you can run:

yarn migrate create my_migration

This will create a file migrations/<timestamp>_my_migration.pgsql that you can place raw sql into. After that, you can run the migration(s) by calling

yarn migrate execute

You can also specify the configuration as cli options

yarn migrate execute --config-directory ~/my/dir/migrations --config-table my-table --config-client postgresql://

In you code you can run it as a library

import { migrate } from '@ovotech/pg-sql-migrate';

await migrate();

Environment variables

In your config file you can use environment variables.

For example, if you have the env var PG_USER_PASS setup, you can access it with:

  "client": "postgresql://postgres:${PG_USER_PASS}@",
  "directory": "migrations"
  "table" "migrations"

Using the library

You can choose a different location for the config file, or to just input its contents directly:

import { migrate } from '@ovotech/pg-sql-migrate';
import { createLogger } from 'winston';

await migrate();

await migrate({ config: 'custom-config.json' });

await migrate({
  config: {
    client: 'postgresql://postgres:dev-pass@',
    // Custom table location
    table: 'my_table',
    // Custom directory for migration files
    directory: 'migrations_dir',

// Custom logger
const logger = createLogger();
await migrate({ logger });

// Dry run
await migrate({ dryRun: true });

Distabling transactions for some migrations

By default migrations are wrapped in transactions, but there are some PG operations that cannot be performed inside a transaction. You can disable this for a specific transaction by adding a prefix

-- pg-sql-migrate: DISABLE TRANSACTION

Running the tests

You can run the tests with:

yarn test

Coding style (linting, etc) tests

Style is maintained with prettier and eslint

yarn lint


Deployment is preferment by circleci automatically on merge / push to master, but you'll need to bump the package version numbers yourself.


Have a bug? File an issue with a simple example that reproduces this so we can take a look & confirm.

Want to make a change? Submit a PR, explain why it's useful, and make sure you've updated the docs (this file) and the tests (see test folder).


This project is licensed under Apache 2 - see the LICENSE file for details

Current Tags

  • 3.2.2                                ...           latest (3 months ago)

11 Versions

  • 3.2.2                                ...           3 months ago
  • 3.2.1                                ...           5 months ago
  • 3.2.0                                ...           5 months ago
  • 3.1.0                                ...           5 months ago
  • 3.0.1                                ...           6 months ago
  • 2.1.0                                ...           7 months ago
  • 2.0.1                                ...           7 months ago
  • 2.0.0                                ...           a year ago
  • 1.0.5                                ...           a year ago
  • 1.0.4                                ...           2 years ago
  • 1.0.3                                ...           2 years ago
Today 0
This Week 1
This Month 2
Last Day 1
Last Week 0
Last Month 0
Dependencies (3)
Dev Dependencies (13)

Copyright 2014 - 2016 © taobao.org |