node-mini-migrations

Mini Migrations for NodeJS

A really simple node migrations library that is completely independant of any database or file system.

Installation

npm install --save node-mini-migrations

Example Usage

There are two examples, one using sqlite and another using a pretend custom file system database.

1. SQLite Driver
2. Filesystem Driver

Preview SQLite driver

const sqlite = require('sqlite')

module.exports = function () {
  let db

  return {
    init: async () => {
      db = await sqlite.open('./test.sqlite')
      await db.run('CREATE TABLE IF NOT EXISTS _migrations (file TEXT PRIMARY KEY);')
    },

    finish: async () => {
      await db.close()
    },

    getMigrationState: async (id) => {
      return db.get('SELECT file FROM _migrations WHERE file = ?', [id])
    },

    setMigrationUp: async (id) => {
      return db.run('INSERT INTO _migrations (file) VALUES (?)', [id])
    },

    setMigrationDown: async (id) => {
      return db.run('DELETE FROM _migrations WHERE file = ?', [id])
    },

    getPassedFunctions: async () => {
      return db
    }
  }
}

Preview SQLite migration

module.exports = {
  up: db => {
    return db.exec('CREATE TABLE test_table (test TEXT)')
  },

  down: db => {
    return db.exec('DROP TABLE test_table')
  }
}

Usage

You run migrator up to bring up any migrations or migrator down to bring them down.

Or inside node app

const {up, prepareRun} = require('node-mini-migrations')
up(prepareRun('./migrations'))

License

This project is licensed under the terms of the MIT license.