migrations-file v0.2.5

migrations-file

A utility for reading SQL-based migration files.

Install

npm install --save migrations-file
# or
yarn add migrations-file

API

Migration

interface Migration {
  filename: string
  version: number
  name: string
  up: string
  down: string
}

readMigrationFile

function readMigrationFile(filename: string): Promise<Migration>

readMigrations

function readMigrations(migrationsPath: string): Promise<Migration[]>

SQL migrations format

001-initial.sql

--------------------------------------------------------------------------------
-- Up
--------------------------------------------------------------------------------
CREATE TABLE test (
  id INTEGER PRIMARY KEY
);
--------------------------------------------------------------------------------
-- Down
--------------------------------------------------------------------------------
DROP TABLE test;

002-add name column.sql

--------------------------------------------------------------------------------
-- Up
--------------------------------------------------------------------------------
ALTER TABLE test
  ADD COLUMN name TEXT;
--------------------------------------------------------------------------------
-- Down
--------------------------------------------------------------------------------
-- https://www.sqlite.org/faq.html#q11
BEGIN TRANSACTION;
  CREATE TEMPORARY TABLE test_backup (
    id   INTEGER PRIMARY KEY
  , name TEXT
  );
  INSERT INTO test_backup
        SELECT id, name FROM test;
  DROP TABLE test;
  CREATE TABLE test (
    id
  );
  INSERT INTO test
        SELECT id FROM test_backup;
  DROP TABLE test_backup;
COMMIT;