@urbica/pg-migrate 1.2.2

@urbica/pg-migrate

1.2.2

PgMigrate ▸
- Instance members
- #connect
- #migrate
- #rollback
- #reset
- #end

Need help reading this?

PgMigrate

pg-migrate.js

PgMigrate

new PgMigrate(options: Object): Promise

Parameters

options (Object) object

Name	Description
options.database `string`	database to apply migrations
options.host `string` (default `'localhost'`)	database host
options.port `int` (default `5432`)	database port
options.user `string`	database user
options.password `string`	database password
options.ssl `boolean`	can also be ISSLConfig-like option https://github.com/vitaly-t/pg-promise/wiki/Connection-Syntax#configuration-object
options.migrationsSchema `string` (default `'public'`)	database migrations table schema
options.migrationsTable `string` (default `'migrations'`)	database migrations table name
options.migrationsDir `string` (default `'./migrations'`)	path to migrations dir
options.verbose `boolean` (default `false`)	attach pg-monitor

Returns

Promise:

Example

const PgMigrate = require('@urbica/pg-migrate');
const pgMigrate = new PgMigrate({ database: 'test', migrationsDir: './migrations' });

pgMigrate
 .connect()
 .then(() => pgMigrate.migrate())
 .then(() => pgMigrate.end());

Instance Members

▸ connect()

pg-migrate.js

prepares database and reads migrations

connect(): Promise

Returns

Promise:

Example

const PgMigrate = require('@urbica/pg-migrate');
const pgMigrate = new PgMigrate();
pgMigrate.connect();

▸ migrate()

pg-migrate.js

runs migrations

migrate(): Promise

Returns

Promise:

Example

const PgMigrate = require('@urbica/pg-migrate');
const pgMigrate = new PgMigrate();
pgMigrate
 .connect()
 .then(() => pgMigrate.migrate());

▸ rollback(limit)

pg-migrate.js

rollbacks migrations

rollback(limit: int): Promise

Parameters

limit

(int
            = 1)

number of migrations to rollback

Returns

Promise:

Example

const PgMigrate = require('@urbica/pg-migrate');
const pgMigrate = new PgMigrate();
pgMigrate
 .connect()
 .then(() => pgMigrate.rollback(1));

▸ reset()

pg-migrate.js

rollbacks all migrations

reset(): Promise

Returns

Promise:

Example

const PgMigrate = require('@urbica/pg-migrate');
const pgMigrate = new PgMigrate();
pgMigrate
 .connect()
 .then(() => pgMigrate.reset());

▸ end()

pg-migrate.js

closes database connection

end(): Promise

Returns

Promise:

Example

const PgMigrate = require('@urbica/pg-migrate');
const pgMigrate = new PgMigrate();
pgMigrate
 .connect()
 .then(() => pgMigrate.end());