mysql-migration 1.0.5 → 1.1.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2023-present 𝐒𝐡𝐞𝐫𝐊𝐚𝐧
+
+This software is protected by copyright and is provided under this license.
+
+You are allowed to use this software only for non-commercial purposes and only in the form in which it is distributed by the author. You are not allowed to modify the source code, redistribute this software in any form, or use it for commercial purposes.
+
+This software is provided "as is," without any warranty of any kind. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the use or distribution of this software.

package/README.md

@@ -4,44 +4,63 @@ A simple command-line tool for generating and running database migrations for My
 
 ## Installation
 
-You can install `mysql-migration` using npm:
-   npm install -g mysql-migration
+You can install `mysql-migration` using npm: `npm install mysql-migration`
 
+### Initialize the migrations table
 
-## Usage
+If you have not yet run any migrations, you need to initialize the migrations table by running the following command: `npx mysql-migration init`
 
-### Create a new migration
+<br>
 
-To create a new migration, run the following command:
-   npx mysql-migration migration-name database-name
+## Configuration
 
-This will create a new migration file in the `migrations` directory with a timestamp and the name `migration-name`.
+The configuration file `mysql-migration.config.json` 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
 
-### Running migrations
+```json
+{
+  "databases": {
+    "db_name": {
+      "host": "db_host",
+      "user": "db_user",
+      "password": "db_password",
+      "database": "db_name"
+    }
+  }
+}
+```
+
+<br>
 
-To run pending migrations, run the following command:
-   npx mysql-migration run database-name (optional)
+## Usage
 
+### Create a new migration
 
-This will run all migrations that have not yet been run.
+To create a new migration, run the following command:\
+&emsp;`npx mysql-migration migration-name database-name`
 
-### Initialize the migrations table
+This will create a new migration file in the `migrations` directory with a timestamp and the name `migration-name`.
+
+### Running migrations
 
-If you have not yet run any migrations, you need to initialize the migrations table by running the following command:
-   npx mysql-migration init
+To run pending migrations, run the following command:\
+&emsp;`npx mysql-migration run database-name(optional)`
 
+This will run all migrations that have not yet been run.
 
-### Configuration
+### Rolling back migrations
 
-The configuration file should export an object with the following properties:
+To roll back the last migration, run the following command:\
+&emsp;`npx mysql-migration rollback database-name batch`
 
-- `host`: the MySQL server host
-- `database`: the name of the database to migrate
-- `user`: the MySQL user name
-- `password`: the MySQL user password
+This will roll back migrations to the given batch number.
 
+<br>
 
-### License
+> **Copyright (c) 2023-present [𝐒𝐡𝐞𝐫𝐊𝐚𝐧](https://github.com/SherKan-n). All Rights Reserved.**
 
-This package is licensed under the MIT License.
+<br>

package/index.js

@@ -1,10 +1,6 @@
 #!/usr/bin/env node
 const program = require('commander');
 //---------------------------------------
-program
-   .version('1.0.0')
-   .description('Migration for mysql database');
-//---------------------------------------
 program
    .command('init')
    .description('Initialize migration')
@@ -15,6 +11,11 @@ program
    .description('Run migration')
    .action((dbName) => require('./src/commands/run')(dbName));
 //---------------------------------------
+program
+   .command('rollback <dbName> <batch>')
+   .description('Run migration backward')
+   .action((dbName, batch) => require('./src/commands/back')(dbName, batch));
+//---------------------------------------
 program
    .command('create <migrationName> <dbName>')
    .description('Create a new migration')

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "mysql-migration",
-   "version": "1.0.5",
+   "version": "1.1.0",
    "description": "Migration for mysql database",
    "main": "index.js",
    "bin": {
@@ -21,5 +21,5 @@
       "commander": "^2.20.0"
    },
    "author": "SherKan",
-   "license": "MIT"
+   "license": "SEE LICENSE IN LICENSE.md"
 }

package/src/commands/back.js

@@ -0,0 +1,65 @@
+'use strict';
+//==============================================================================
+const fs = require('fs');
+const mysql = require('mysql');
+//---------------------------------------
+const currentPath = process.cwd();
+const config = require(`${currentPath}/migrations/mysql-migration.config.json`);
+const { checkTableMigrations, createTableMigrations, getAllMigrations, getCurrentBatch, deleteMigration } = require("../utils/functions");
+//==============================================================================
+async function back_migration(dbName, batch) {
+   const connection = {};
+   const databases = config.databases;
+   //---------------------------------------
+   if (dbName) {
+      const batchNumber = parseInt(batch);
+      if (isNaN(batchNumber)) {
+         console.error('\x1b[31m%s\x1b[0m', `Error: Invalid batch number.`);
+         process.exit(1);
+      }
+      //---------------------------------------
+      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 currentBatch = await getCurrentBatch(connection[dbName]);
+      if (batchNumber >= currentBatch) {
+         console.error('\x1b[31m%s\x1b[0m', `Error: Invalid batch number, the current batch is "${currentBatch}".`);
+         process.exit(1);
+      }
+      const migrations = await getAllMigrations(connection[dbName], batchNumber);
+      //---------------------------------------
+      for (let file of migrations) {
+         if (!fs.existsSync(`${currentPath}/migrations/${dbName}_db/${file.migration}.js`)) {
+            console.warn('\x1b[33m%s\x1b[0m', `Warning: Migration "${file.migration}" not found.`);
+         }
+         else {
+            const migration = require(`${currentPath}/migrations/${dbName}_db/${file.migration}`);
+            try {
+               await migration.down(connection[dbName]);
+               await deleteMigration(connection[dbName], file.migration, batchNumber);
+               console.log('\x1b[32m%s\x1b[0m', `Migration "${file.migration}" has been successfully rolled back.`);
+            }
+            catch (err) {
+               console.warn('\x1b[33m%s\x1b[0m', `Warning: "${err}" in migration "${file.migration}".`);
+            }
+         }
+      }
+      connection[dbName].end();
+   }
+   else console.error('\x1b[31m%s\x1b[0m', `Error: Database name is empty !`);
+}
+//==============================================================================
+module.exports = back_migration;

package/src/commands/create.js

@@ -4,7 +4,7 @@ const fs = require('fs');
 const moment = require('moment');
 //---------------------------------------
 const currentPath = process.cwd();
-const config = require(`${currentPath}/migrations/config.json`);
+const config = require(`${currentPath}/migrations/mysql-migration.config.json`);
 //---------------------------------------
 function create_migration(migrationName, dbName) {
    if (!migrationName) {

package/src/commands/init.js

@@ -5,7 +5,7 @@ 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({
+if (!fs.existsSync(`${currentPath}/migrations/mysql-migration.config.json`)) fs.writeFileSync(`${currentPath}/migrations/mysql-migration.config.json`, JSON.stringify({
    "databases": {
       "db_name": {
          "host": "db_host",
@@ -15,4 +15,4 @@ if (!fs.existsSync(`${currentPath}/migrations/config.json`)) fs.writeFileSync(`$
       }
    }
 }, null, 3));
-console.log('\x1b[32m%s\x1b[0m', `Created migration config file: "config.json" in the "migrations" directory.`);
+console.log('\x1b[32m%s\x1b[0m', `Created migration config file: "mysql-migration.config.json" in the "migrations" directory.`);

package/src/commands/run.js

@@ -4,7 +4,7 @@ const fs = require('fs');
 const mysql = require('mysql');
 //---------------------------------------
 const currentPath = process.cwd();
-const config = require(`${currentPath}/migrations/config.json`);
+const config = require(`${currentPath}/migrations/mysql-migration.config.json`);
 const { checkTableMigrations, createTableMigrations, getAllMigrations, getCurrentBatch, insertMigration } = require("../utils/functions");
 //==============================================================================
 async function run_migration(dbName) {

package/src/utils/functions.js

@@ -22,9 +22,11 @@ function createTableMigrations(connection) {
    });
 }
 //---------------------------------------
-function getAllMigrations(connection) {
+function getAllMigrations(connection, batch = null) {
    return new Promise((resolve) => {
-      connection.query("SELECT `migration` FROM `migrations`;", (error, results) => {
+      let query = "SELECT `migration` FROM `migrations`";
+      if (batch) query += " WHERE `batch` > ?;";
+      connection.query(query, [batch], (error, results) => {
          if (error) throw error;
          if (results?.length > 0) resolve(results);
          else resolve([]);
@@ -52,6 +54,16 @@ function insertMigration(connection, migration, batch) {
    });
 }
 //---------------------------------------
+function deleteMigration(connection, migration, batch) {
+   return new Promise((resolve) => {
+      const query = `DELETE FROM \`migrations\` WHERE \`migration\` = '${migration}' AND \`batch\` > '${batch}';`
+      connection.query(query, (error) => {
+         if (error) throw error;
+         resolve(true);
+      });
+   });
+}
+//---------------------------------------
 module.exports = {
-   checkTableMigrations, createTableMigrations, getAllMigrations, getCurrentBatch, insertMigration
+   checkTableMigrations, createTableMigrations, getAllMigrations, getCurrentBatch, insertMigration, deleteMigration
 }