feat(migration): add renameTable method for table renaming functionality

Author: AxiosLeo

index.d.ts

@@ -688,9 +688,26 @@ export declare class MigrationInterface {
    */
   dropForeignKey(tableName: string, foreign_key: string): void;
 
+  /**
+   * insert data into table
+   * @param table 
+   * @param data 
+   */
   insertData(table: string, data: any[]): void;
 
+  /**
+   * execute raw sql
+   * @param sql 
+   * @param values 
+   */
   raw(sql: string, values: any[]): void;
+
+  /**
+   * rename table
+   * @param oldTableName 
+   * @param newTableName 
+   */
+  renameTable(oldTableName: string, newTableName: string): void;
 }
 
 export type MigrateAction = 'up' | 'down' | 'UP' | 'DOWN';

src/builder.js

@@ -523,6 +523,14 @@ class ManageSQLBuilder extends Builder {
     }
   }
 
+  renameTable(options) {
+    _validate(options, {
+      oldName: 'required|string',
+      newName: 'required|string',
+    });
+    return _render('RENAME TABLE `${oldName}` TO `${newName}`', options);
+  }
+
   /**
    * @param {import('./migration').ManageBuilderOptions} options 
    */

src/migration.js

@@ -325,6 +325,18 @@ function _initMigration(file, queries = {}) {
     }, ...baseAttr
   });
 
+  Object.defineProperty(migration, 'renameTable', {
+    value: function (oldTableName, newTableName) {
+      const builder = new ManageSQLBuilder({
+        operator: 'rename',
+        target: 'table',
+        oldName: oldTableName,
+        newName: newTableName
+      });
+      queries[file].push({ sql: builder.sql, values: builder.values });
+    }, ...baseAttr
+  });
+
   return migration;
 }