mysql-migration 1.0.5

package/README.md

@@ -0,0 +1,47 @@
+# MySQL Migration Database
+
+A simple command-line tool for generating and running database migrations for MySQL.
+
+## Installation
+
+You can install `mysql-migration` using npm:
+   npm install -g mysql-migration
+
+
+## Usage
+
+### Create a new migration
+
+To create a new migration, run the following command:
+   npx mysql-migration migration-name database-name
+
+This will create a new migration file in the `migrations` directory with a timestamp and the name `migration-name`.
+
+
+### Running migrations
+
+To run pending migrations, run the following command:
+   npx mysql-migration run database-name (optional)
+
+
+This will run all migrations that have not yet been run.
+
+### Initialize the migrations table
+
+If you have not yet run any migrations, you need to initialize the migrations table by running the following command:
+   npx mysql-migration init
+
+
+### Configuration
+
+The configuration file should export an object with the following properties:
+
+- `host`: the MySQL server host
+- `database`: the name of the database to migrate
+- `user`: the MySQL user name
+- `password`: the MySQL user password
+
+
+### License
+
+This package is licensed under the MIT License.

package/index.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+const program = require('commander');
+//---------------------------------------
+program
+   .version('1.0.0')
+   .description('Migration for mysql database');
+//---------------------------------------
+program
+   .command('init')
+   .description('Initialize migration')
+   .action(() => require('./src/commands/init'));
+//---------------------------------------
+program
+   .command('run [dbName]')
+   .description('Run migration')
+   .action((dbName) => require('./src/commands/run')(dbName));
+//---------------------------------------
+program
+   .command('create <migrationName> <dbName>')
+   .description('Create a new migration')
+   .action((migrationName, dbName) => require('./src/commands/create')(migrationName, dbName));
+//---------------------------------------
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,25 @@
+{
+   "name": "mysql-migration",
+   "version": "1.0.5",
+   "description": "Migration for mysql database",
+   "main": "index.js",
+   "bin": {
+      "mysql-migration": "./index.js"
+   },
+   "scripts": {
+      "test": "echo \"Error: no test specified\" && exit 1"
+   },
+   "keywords": [
+      "mysql migration",
+      "migration",
+      "mysql"
+   ],
+   "dependencies": {
+      "mysql": "^2.18.1",
+      "moment": "^2.24.0",
+      "fs": "0.0.1-security",
+      "commander": "^2.20.0"
+   },
+   "author": "SherKan",
+   "license": "MIT"
+}

package/src/commands/create.js

@@ -0,0 +1,60 @@
+'use strict';
+//---------------------------------------
+const fs = require('fs');
+const moment = require('moment');
+//---------------------------------------
+const currentPath = process.cwd();
+const config = require(`${currentPath}/migrations/config.json`);
+//---------------------------------------
+function create_migration(migrationName, dbName) {
+   if (!migrationName) {
+      console.error('\x1b[31m%s\x1b[0m', `Error: Migration name is empty !`);
+      process.exit(1);
+   }
+   //---------------------------------------
+   const databases = Object.keys(config.databases);
+   //---------------------------------------
+   if (!databases.includes(dbName)) {
+      console.error('\x1b[31m%s\x1b[0m', `Error: Invalid database name "${dbName}" can be: ${databases.join(', ')}.`);
+      process.exit(1);
+   }
+   //---------------------------------------
+   if (!fs.existsSync(`${currentPath}/migrations/${dbName}_db`)) fs.mkdirSync(`${currentPath}/migrations/${dbName}_db`);
+   //---------------------------------------
+   const currentDate = moment().format('YYYY_MM_DD_HHmmss');
+   const fileName = `${currentDate}_${migrationName}.js`;
+   const filePath = `${currentPath}/migrations/${dbName}_db/${fileName}`;
+   //---------------------------------------
+   if (fs.existsSync(filePath)) console.warn('\x1b[33m%s\x1b[0m', `Warning: File "${fileName}" already exists in the "migrations" directory.`);
+   else {
+      const dataText = `module.exports = {
+   up: (connection) => {
+      const query = "";
+
+      return new Promise((resolve, reject) => {
+         if (!query) reject('Migration query is empty !');
+         connection.query(query, (err) => {
+            if (err) reject(err);
+            resolve();
+         });
+      });
+   },
+
+   down: (connection) => {
+      const query = "";
+
+      return new Promise((resolve, reject) => {
+         if (!query) reject('Migration query is empty !');
+         connection.query(query, (err) => {
+            if (err) reject(err);
+            resolve();
+         });
+      });
+   }
+};`
+      fs.writeFileSync(filePath, dataText);
+      console.log('\x1b[32m%s\x1b[0m', `Created migration file: "${fileName}".`);
+   }
+}
+//---------------------------------------
+module.exports = create_migration;

package/src/commands/init.js

@@ -0,0 +1,18 @@
+'use strict';
+//---------------------------------------
+const fs = require('fs');
+//---------------------------------------
+const currentPath = process.cwd();
+//---------------------------------------
+if (!fs.existsSync(`${currentPath}/migrations`)) fs.mkdirSync(`${currentPath}/migrations`);
+if (!fs.existsSync(`${currentPath}/migrations/config.json`)) fs.writeFileSync(`${currentPath}/migrations/config.json`, JSON.stringify({
+   "databases": {
+      "db_name": {
+         "host": "db_host",
+         "user": "db_user",
+         "password": "db_password",
+         "database": "db_name"
+      }
+   }
+}, null, 3));
+console.log('\x1b[32m%s\x1b[0m', `Created migration config file: "config.json" in the "migrations" directory.`);

package/src/commands/run.js

@@ -0,0 +1,103 @@
+'use strict';
+//==============================================================================
+const fs = require('fs');
+const mysql = require('mysql');
+//---------------------------------------
+const currentPath = process.cwd();
+const config = require(`${currentPath}/migrations/config.json`);
+const { checkTableMigrations, createTableMigrations, getAllMigrations, getCurrentBatch, insertMigration } = require("../utils/functions");
+//==============================================================================
+async function run_migration(dbName) {
+   const connection = {}, migrations = [];
+   const databases = config.databases;
+   //---------------------------------------
+   if (dbName) {
+      if (!databases[dbName]) {
+         console.error('\x1b[31m%s\x1b[0m', `Error: Invalid database name "${dbName}".`);
+         process.exit(1);
+      }
+      //---------------------------------------
+      connection[dbName] = mysql.createConnection(databases[dbName]);
+      connection[dbName].connect((err) => {
+         if (err) {
+            console.error('\x1b[31m%s\x1b[0m', `Error: Unable to connect to database "${dbName}".\n${err}`);
+            process.exit(1);
+         }
+      });
+      //---------------------------------------
+      const tableMigrations = await checkTableMigrations(connection[dbName]);
+      if (!tableMigrations) await createTableMigrations(connection[dbName]);
+      //---------------------------------------
+      const batch = await getCurrentBatch(connection[dbName]) + 1;
+      const allMigrations = await getAllMigrations(connection[dbName]);
+      const migration = fs.readdirSync(`${currentPath}/migrations/${dbName}_db`);
+      //---------------------------------------
+      const migrations = migration.filter(val => !allMigrations.some(val2 => val.includes(val2.migration)));
+      //---------------------------------------
+      if (migrations.length === 0) {
+         console.log('\x1b[32m%s\x1b[0m', 'Nothing to migrate.\n');
+         connection[dbName].end();
+         process.exit(1);
+      }
+      //---------------------------------------
+      for (let file of migrations) {
+         const migration = require(`${currentPath}/migrations/${dbName}_db/${file}`);
+         try {
+            await migration.up(connection[dbName]);
+            await insertMigration(connection[dbName], file.replace('.js', ''), batch);
+            console.log('\x1b[36m%s\x1b[0m', `Migrated: "${file}" successfully.`);
+         }
+         catch (err) {
+            console.warn('\x1b[33m%s\x1b[0m', `Warning: "${err}" in migration "${file}".`);
+         }
+      }
+      console.log('\x1b[32m%s\x1b[0m', 'All migrations have been completed successfully.\n');
+      connection[dbName].end();
+   }
+   else {
+      for (let key in databases) {
+         connection[key] = mysql.createConnection(databases[key]);
+         connection[key].connect((err) => {
+            if (err) {
+               console.error('\x1b[31m%s\x1b[0m', `Error: Unable to connect to database "${key}".`);
+               process.exit(1);
+            }
+         });
+         //---------------------------------------
+         const tableMigrations = await checkTableMigrations(connection[key]);
+         if (!tableMigrations) await createTableMigrations(connection[key]);
+         //---------------------------------------
+         const batch = await getCurrentBatch(connection[key]) + 1;
+         const allMigrations = await getAllMigrations(connection[key]);
+         //---------------------------------------
+         if (!fs.existsSync(`${currentPath}/migrations/${key}_db`)) continue;
+         const migration = fs.readdirSync(`${currentPath}/migrations/${key}_db`);
+         //---------------------------------------
+         const diffMigrations = migration.filter(val => !allMigrations.some(val2 => val.includes(val2.migration)));
+         //---------------------------------------
+         for (let m of diffMigrations) migrations.push([m, key, batch]);
+      }
+      //---------------------------------------
+      if (migrations.length === 0) {
+         console.log('\x1b[32m%s\x1b[0m', 'Nothing to migrate.\n');
+         for (let key in connection) connection[key].end();
+         process.exit(1);
+      }
+      //---------------------------------------
+      for (let [file, key, batch] of migrations) {
+         const migration = require(`${currentPath}/migrations/${key}_db/${file}`);
+         try {
+            await migration.up(connection[key]);
+            await insertMigration(connection[key], file.replace('.js', ''), batch);
+            console.log('\x1b[36m%s\x1b[0m', `Migrated: "${file}" in database "${key}" successfully.`);
+         }
+         catch (err) {
+            console.warn('\x1b[33m%s\x1b[0m', `Warning: "${err}" in migration "${file}" in database "${key}".`);
+         }
+      }
+      console.log('\x1b[32m%s\x1b[0m', 'All migrations have been completed successfully.\n');
+      for (let key in connection) connection[key].end();
+   }
+}
+//==============================================================================
+module.exports = run_migration;

package/src/utils/functions.js

@@ -0,0 +1,57 @@
+function checkTableMigrations(connection) {
+   return new Promise((resolve) => {
+      connection.query("SELECT `id` FROM `migrations` LIMIT 1;", (error) => {
+         if (error) resolve(false);
+         else resolve(true);
+      });
+   });
+}
+//---------------------------------------
+function createTableMigrations(connection) {
+   return new Promise((resolve) => {
+      const query = "CREATE TABLE `migrations` (\
+         `id` INT NOT NULL AUTO_INCREMENT,\
+         `migration` VARCHAR(255) NOT NULL,\
+         `batch` INT NOT NULL DEFAULT 1,\
+         `created_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,\
+         PRIMARY KEY (`id`));"
+      connection.query(query, (error) => {
+         if (error) throw error;
+         resolve(true);
+      });
+   });
+}
+//---------------------------------------
+function getAllMigrations(connection) {
+   return new Promise((resolve) => {
+      connection.query("SELECT `migration` FROM `migrations`;", (error, results) => {
+         if (error) throw error;
+         if (results?.length > 0) resolve(results);
+         else resolve([]);
+      });
+   });
+}
+//---------------------------------------
+function getCurrentBatch(connection) {
+   return new Promise((resolve) => {
+      connection.query("SELECT `batch` FROM `migrations` ORDER BY `batch` DESC LIMIT 1;", (error, results) => {
+         if (error) throw error;
+         if (results?.length > 0) resolve(results[0].batch);
+         else resolve(0);
+      });
+   });
+}
+//---------------------------------------
+function insertMigration(connection, migration, batch) {
+   return new Promise((resolve) => {
+      const query = `INSERT INTO \`migrations\` (\`migration\`, \`batch\`) VALUES ('${migration}', '${batch}');`
+      connection.query(query, (error) => {
+         if (error) throw error;
+         resolve(true);
+      });
+   });
+}
+//---------------------------------------
+module.exports = {
+   checkTableMigrations, createTableMigrations, getAllMigrations, getCurrentBatch, insertMigration
+}