Slonik Migrator

Run sequential migration files against a PostgreSQL database.

Installation

Install from NPM:

$ yarn add @reagent/migrator

Usage

Migration files need to start with 3 digits and end with a .sql suffix:

001_create_users.sql

Place your migrations in a directory and then build a runner that executes them:

1//
2// src/db/migrator.ts
3//
4import path from 'path';
5import { createPool } from 'slonik';
6import { Migrator } from '@reagent/migrator';
7
8const { DATABASE_URL } = process.env;
9
10(async () => {
11  const migrationsPath = path.resolve(__dirname, 'migrations');
12  const pool = await createPool(DATABASE_URL);
13
14  const migrator = new Migrator({ migrationsPath, pool });
15  await migrator.migrate();
16})();

You can run them with ts-node or tie them into your build process:

$ yarn ts-node src/db/migrator.ts

The migrator also supports logging with @reagent/logging or a compatible logging interface:

1import { createLogger } from '@reagent/logging';
2
3(async () => {
4  // ...
5  const logger = createLogger({ stdout: true });
6
7  const migrator = new Migrator({ migrationsPath, pool, logger });
8  await migrator.migrate();
9})();