Merge pull request #15 from leapfrogtechnology/support-trx

Support knex transactions in synchronize

src/Connection.ts

@@ -1,6 +1,7 @@
 import * as Knex from 'knex';
 
 import ConnectionConfig from './domain/ConnectionConfig';
+import DbConnectionInstance from './domain/DbConnectionInstance';
 import RawBindingParams, { ValueMap } from './domain/RawBingingParams';
 
 /**
@@ -29,7 +30,7 @@ class Connection {
    * @param {any} obj
    * @returns {boolean}
    */
-  public static isKnexInstance(obj: any): obj is Knex {
+  public static isKnexInstance(obj: any): obj is DbConnectionInstance {
     return !!(obj.prototype && obj.prototype.constructor && obj.prototype.constructor.name === 'knex');
   }
 

src/domain/DbConnectionInstance.ts

@@ -0,0 +1,8 @@
+import * as Knex from 'knex';
+
+/**
+ * Database connection instances.
+ */
+type DbConnectionInstance = Knex | Knex.Transaction;
+
+export default DbConnectionInstance;

src/migrator.ts

@@ -1,11 +1,10 @@
-import * as Knex from 'knex';
-
 import Connection from './Connection';
 import { log, dbLogger } from './logger';
 import * as sqlRunner from './sqlRunner';
 import SyncParams from './domain/SyncParams';
 import SyncConfig from './domain/SyncConfig';
 import ConnectionConfig from './domain/ConnectionConfig';
+import DbConnectionInstance from './domain/DbConnectionInstance';
 
 /**
  * Migrate SQL on a database.
@@ -79,12 +78,12 @@ export function teardown(config: SyncConfig): (connection: Connection) => Promis
  * Synchronize database.
  *
  * @param {SyncConfig} config
- * @param {ConnectionConfig[] | Knex[] | ConnectionConfig | Knex} connections
+ * @param {ConnectionConfig[] | DbConnectionInstance[] | ConnectionConfig | DbConnectionInstance} conn
  * @param {SyncParams} params
  */
 export async function synchronize(
   config: SyncConfig,
-  conn: ConnectionConfig[] | Knex[] | ConnectionConfig | Knex,
+  conn: ConnectionConfig[] | DbConnectionInstance[] | ConnectionConfig | DbConnectionInstance,
   params?: SyncParams
 ) {
   log('Starting to synchronize.');