feat(migration, builder): add changeColumn method for modifying existing columns

Author: AxiosLeo

index.d.ts

@@ -708,6 +708,16 @@ export declare class MigrationInterface {
    * @param newTableName 
    */
   renameTable(oldTableName: string, newTableName: string): void;
+
+  /**
+   * change column
+   * @param tableName 
+   * @param columnName 
+   * @param options 
+   */
+  changeColumn(tableName: string, columnName: string, options: {
+    type: FieldType,
+  } & CreateColumnOptions): void;
 }
 
 export type MigrateAction = 'up' | 'down' | 'UP' | 'DOWN';

src/builder.js

@@ -523,6 +523,18 @@ class ManageSQLBuilder extends Builder {
     }
   }
 
+  changeColumn(options) {
+    _validate(options, {
+      tableName: 'required|string',
+      columnName: 'required|string',
+    });
+    const columnOptions = {
+      ...options.options,
+      name: options.columnName,
+    };
+    return _render('ALTER TABLE `${tableName}` MODIFY COLUMN ' + this.renderSingleColumn(columnOptions), { tableName: options.tableName });
+  }
+
   renameTable(options) {
     _validate(options, {
       oldName: 'required|string',

src/migration.js

@@ -337,6 +337,19 @@ function _initMigration(file, queries = {}) {
     }, ...baseAttr
   });
 
+  Object.defineProperty(migration, 'changeColumn', {
+    value: function (tableName, columnName, options) {
+      const builder = new ManageSQLBuilder({
+        operator: 'change',
+        target: 'column',
+        tableName,
+        columnName,
+        options
+      });
+      queries[file].push({ sql: builder.sql, values: builder.values });
+    }, ...baseAttr
+  });
+
   return migration;
 }