mysql-migration 1.1.0 → 1.2.0

package/README.md

@@ -41,7 +41,7 @@ The configuration file `mysql-migration.config.json` should export an object wit
 ### Create a new migration
 
 To create a new migration, run the following command:\
- `npx mysql-migration migration-name database-name`
+ `npx mysql-migration create migration-name database-name`
 
 This will create a new migration file in the `migrations` directory with a timestamp and the name `migration-name`.
 
@@ -59,8 +59,4 @@ To roll back the last migration, run the following command:\
 
 This will roll back migrations to the given batch number.
 
-<br>
-
 > **Copyright (c) 2023-present [𝐒𝐡𝐞𝐫𝐊𝐚𝐧](https://github.com/SherKan-n). All Rights Reserved.**
-
-<br>

package/index.js

@@ -1,6 +1,20 @@
 #!/usr/bin/env node
 const program = require('commander');
 //---------------------------------------
+program
+   .command('help')
+   .description('Show all available commands')
+   .action(() => {
+      console.log(`\nUsage: cli-tool <command> [options]\n`);
+      console.log(`Available commands:\n`);
+      console.log(`  init                      Initialize migration`);
+      console.log(`  run [dbName]              Run migration`);
+      console.log(`  rollback <dbName> <batch> Rollback migration`);
+      console.log(`  create <name> <dbName>    Create a new migration`);
+      console.log(`  batch <dbName>            Get the batched migrations`);
+      console.log(`  help                      Show this help message\n`);
+   });
+//---------------------------------------
 program
    .command('init')
    .description('Initialize migration')
@@ -13,7 +27,7 @@ program
 //---------------------------------------
 program
    .command('rollback <dbName> <batch>')
-   .description('Run migration backward')
+   .description('Rollback migration')
    .action((dbName, batch) => require('./src/commands/back')(dbName, batch));
 //---------------------------------------
 program
@@ -21,4 +35,9 @@ program
    .description('Create a new migration')
    .action((migrationName, dbName) => require('./src/commands/create')(migrationName, dbName));
 //---------------------------------------
+program
+   .command('batch <dbName>')
+   .description('Get the batched migrations')
+   .action(() => require('./src/commands/batch'));
+//---------------------------------------
 program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "mysql-migration",
-   "version": "1.1.0",
+   "version": "1.2.0",
    "description": "Migration for mysql database",
    "main": "index.js",
    "bin": {
@@ -15,10 +15,10 @@
       "mysql"
    ],
    "dependencies": {
-      "mysql": "^2.18.1",
-      "moment": "^2.24.0",
+      "commander": "^13.1.0",
       "fs": "0.0.1-security",
-      "commander": "^2.20.0"
+      "moment": "^2.30.1",
+      "mysql2": "^3.13.0"
    },
    "author": "SherKan",
    "license": "SEE LICENSE IN LICENSE.md"

package/src/commands/back.js

@@ -1,7 +1,7 @@
 'use strict';
 //==============================================================================
 const fs = require('fs');
-const mysql = require('mysql');
+const mysql = require('mysql2');
 //---------------------------------------
 const currentPath = process.cwd();
 const config = require(`${currentPath}/migrations/mysql-migration.config.json`);

package/src/commands/batch.js

@@ -0,0 +1,52 @@
+'use strict';
+//==============================================================================
+const mysql = require('mysql2');
+//---------------------------------------
+const currentPath = process.cwd();
+const config = require(`${currentPath}/migrations/mysql-migration.config.json`);
+const { checkTableMigrations, createTableMigrations, getAllBatches, getCurrentBatch } = require("../utils/functions");
+//==============================================================================
+async function show_batched_migrations(dbName) {
+    const connection = {};
+    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 = checkTableMigrations(connection[dbName]);
+        if (!tableMigrations) createTableMigrations(connection[dbName]);
+        //---------------------------------------
+        const currentBatch = await getCurrentBatch(connection[dbName]);
+        //---------------------------------------
+        getAllBatches(connection[dbName]).then((migrations) => {
+            if (migrations.length > 0) {
+                console.log('\x1b[32m%s\x1b[0m', `Batched migrations for database "${dbName}":`);
+                migrations.forEach((migration) => {
+                    const migrationName = migration.migration.split('_').slice(4).join('_');
+                    console.log(`[Batch ${migration.batch}] - ${migrationName}`);
+                });
+            }
+            else console.log('\x1b[32m%s\x1b[0m', `No batched migrations for database "${dbName}".`);
+            connection[dbName].end();
+        }).catch((err) => {
+            console.error('\x1b[31m%s\x1b[0m', `Error: ${err}`);
+            connection[dbName].end();
+        }).finally(() => {
+            console.log('\x1b[36m%s\x1b[0m', `Current batch for database "${dbName}": ${currentBatch}`);
+        });
+    }
+    else console.error('\x1b[31m%s\x1b[0m', `Error: Database name is empty !`);
+}
+//==============================================================================
+module.exports = show_batched_migrations;

package/src/commands/run.js

@@ -1,7 +1,7 @@
 'use strict';
 //==============================================================================
 const fs = require('fs');
-const mysql = require('mysql');
+const mysql = require('mysql2');
 //---------------------------------------
 const currentPath = process.cwd();
 const config = require(`${currentPath}/migrations/mysql-migration.config.json`);

package/src/utils/functions.js

@@ -64,6 +64,16 @@ function deleteMigration(connection, migration, batch) {
    });
 }
 //---------------------------------------
+function getAllBatches(connection) {
+   return new Promise((resolve) => {
+      connection.query("SELECT `batch`, `migration` FROM `migrations`;", (error, results) => {
+         if (error) throw error;
+         resolve(results?.length > 0 ? results : []);
+      });
+   });
+}
+//---------------------------------------
 module.exports = {
-   checkTableMigrations, createTableMigrations, getAllMigrations, getCurrentBatch, insertMigration, deleteMigration
+   checkTableMigrations, createTableMigrations, getAllMigrations, getCurrentBatch, insertMigration, deleteMigration,
+   getAllBatches
 }