knex-migrator 4.1.1 → 4.2.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2021 Ghost Foundation
+Copyright (c) 2013-2022 Ghost Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -52,7 +52,7 @@ Please add a file named `MigratorConfig.js`. Knex-migrator will load the config
 ```
 module.exports = {
     database: {
-        client:         String          (Required) ['mysql', 'sqlite3']
+        client:         String          (Required) ['mysql', 'mysql2', 'sqlite3']
         connection: {
             host:       String,         (Required) [e.g. '127.0.0.1']
             user:       String,         (Required)
@@ -338,7 +338,7 @@ knexMigrator.isDatabaseOK()
 
 # Copyright & License
 
-Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE).
+Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).
 
 
 

package/lib/database.js

@@ -12,16 +12,21 @@ const knex = require('knex'),
  */
 exports.connect = function connect(options) {
     options = options || {};
+
+    // Alias `mysql` to `mysql2` so we can maintain backwards compatibility
+    if (options.client === 'mysql') {
+        options.client = 'mysql2';
+    }
+
     const client = options.client;
 
     if (client === 'sqlite3') {
         options.useNullAsDefault = options.useNullAsDefault || false;
     }
 
-    if (client === 'mysql') {
-        options.connection.timezone = options.connection.timezone || 'UTC';
+    if (client === 'mysql2') {
+        options.connection.timezone = options.connection.timezone || 'Z';
         options.connection.charset = options.connection.charset || 'utf8mb4';
-        options.connection.collation = options.connection.collation || 'utf8mb4_general_ci';
     }
 
     return knex(options);
@@ -102,7 +107,7 @@ exports.createDatabaseIfNotExist = function createDatabaseIfNotExist(dbConfig) {
     // @NOTE: Skip, because sqlite3 is a file based database.
     if (dbConfig.client === 'sqlite3') {
         return Promise.resolve();
-    } else if (dbConfig.client !== 'mysql') {
+    } else if (!['mysql', 'mysql2'].includes(dbConfig.client)) {
         return Promise.reject(new errors.KnexMigrateError({
             message: 'Database is not supported.'
         }));
@@ -157,7 +162,7 @@ exports.drop = function drop(options) {
     const connection = options.connection,
         dbConfig = options.dbConfig;
 
-    if (dbConfig.client === 'mysql') {
+    if (['mysql', 'mysql2'].includes(dbConfig.client)) {
         debug('Drop database: ' + dbConfig.connection.database);
 
         return connection.raw('DROP DATABASE `' + dbConfig.connection.database + '`;')

package/lib/index.js

@@ -155,30 +155,33 @@ KnexMigrator.prototype.init = function init(options) {
                                 throw err;
                             }
 
-                            return database.createTransaction(self.connection, function (transacting) {
+                            return database.createTransaction(self.connection, async function (transacting) {
+                                const existingMigrations = await transacting('migrations').select('name');
+                                const existingMigrationsNames = existingMigrations.map(m => m.name);
+                                const migrationsToAdd = [];
+
                                 // CASE: Run over all migration scripts and add the file name to the database.
-                                return Promise.each(versionsToMigrateTo, function (versionToMigrateTo) {
+                                for (const versionToMigrateTo of versionsToMigrateTo) {
                                     let versionPath = path.join(self.migrationPath, self.subfolder, versionToMigrateTo);
                                     let filesToMigrateTo = utils.listFiles(versionPath) || [];
 
-                                    return Promise.each(filesToMigrateTo, function (fileToMigrateTo) {
-                                        // CASE: check if migration exists, do not insert twice
-                                        return transacting('migrations')
-                                            .where('name', fileToMigrateTo)
-                                            .then(function (migrationExists) {
-                                                if (migrationExists.length) {
-                                                    return Promise.resolve();
-                                                }
-
-                                                return transacting('migrations')
-                                                    .insert({
-                                                        name: fileToMigrateTo,
-                                                        version: versionToMigrateTo,
-                                                        currentVersion: self.currentVersion
-                                                    });
-                                            });
-                                    });
-                                });
+                                    // CASE: check if migration exists, do not insert twice
+                                    for (const name of filesToMigrateTo) {
+                                        if (existingMigrationsNames.includes(name)) {
+                                            continue;
+                                        }
+
+                                        migrationsToAdd.push({
+                                            name,
+                                            version: versionToMigrateTo,
+                                            currentVersion: self.currentVersion
+                                        });
+                                    }
+                                }
+
+                                await self.connection
+                                    .batchInsert('migrations', migrationsToAdd)
+                                    .transacting(transacting);
                             });
                         })
                         .then(function () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex-migrator",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "Database migrations with knex.",
   "keywords": [
     "ghost",
@@ -50,13 +50,13 @@
     "bluebird": "3.7.2",
     "commander": "5.1.0",
     "compare-ver": "2.0.2",
-    "debug": "4.3.2",
+    "debug": "4.3.3",
     "ghost-ignition": "4.6.3",
     "knex": "0.21.19",
     "lodash": "4.17.21",
     "moment": "2.24.0",
     "nconf": "0.11.3",
-    "resolve": "1.20.0"
+    "resolve": "1.22.0"
   },
   "files": [
     "bin",
@@ -74,7 +74,7 @@
     "sinon": "9.2.4"
   },
   "optionalDependencies": {
-    "mysql": "2.18.1",
+    "mysql2": "2.3.3",
     "sqlite3": "5.0.2"
   }
 }