knex-sql-file-migration

Use sql files instead of knex.schema methods.

Exports up and down functions whichs executes knex.raw() method on SQL files having same file name appended .up.sql and .down.sql.

This is a fork of knex-migrate-sql-file with multiple queries support and transaction usage on migrate

Synopsis

1. Create knex migration file
2. Import this library in migration file
3. Create SQL files

$ knex migrate:make add-user-table
Created Migration: /some/path/20180516163212_add-user-table.js

/some/path/20180516163212_add-user-table.js

//                      Don't forget function call ⤵
module.exports = require("knex-sql-file-migration")();

/some/path/20180516163212_add-user-table.up.sql

CREATE TABLE "user";

CREATE TABLE "user_profile";

To use multiple queries on a file, close each with a ;

/some/path/20180516163212_add-user-table.down.sql

DROP TABLE "user";

DROP TABLE "user_profile";

You can override up or down function according to your needs.

API

Functions

up(knex)

Reads .up.sql file and executes it using knex.raw() method.

Kind: global function

| Param | Type | Description | | ----- | ----------------- | ----------- | | knex | Knex | Knex object |

Example

module.exports = require("knex-sql-file-migration")();

down(knex)

Reads .down.sql file and executes it using knex.raw() method.

Kind: global function

| Param | Type | Description | | ----- | ----------------- | ----------- | | knex | Knex | Knex object |

Example

module.exports = require("knex-sql-file-migration")();