rake-db 2.22.0 → 2.22.2

package/dist/index.d.ts

@@ -214,6 +214,25 @@ declare const tableChangeMethods: {
     nullable(): Change;
     nonNullable(): Change;
     comment(comment: string | null): Change;
+    /**
+     * Rename a column:
+     *
+     * ```ts
+     * import { change } from '../dbScript';
+     *
+     * change(async (db) => {
+     *   await db.changeTable('table', (t) => ({
+     *     oldColumnName: t.rename('newColumnName'),
+     *   }));
+     * });
+     * ```
+     *
+     * Note that the renaming `ALTER TABLE` is executed before the rest of alterations,
+     * so if you're also adding a new constraint on this column inside the same `changeTable`,
+     * refer to it with a new name.
+     *
+     * @param name
+     */
     rename(name: string): RakeDbAst.ChangeTableItem.Rename;
     primaryKey<Columns extends [string, ...string[]], Name extends string>(columns: Columns, name?: Name | undefined): {
         tableDataItem: true;
@@ -222,7 +241,25 @@ declare const tableChangeMethods: {
     };
     unique<Columns_1 extends [string | TableData.Index.ColumnOrExpressionOptions<string>, ...(string | TableData.Index.ColumnOrExpressionOptions<string>)[]], Name_1 extends string>(columns: Columns_1, ...args: [options?: TableData.Index.UniqueOptionsArg | undefined] | [name?: Name_1 | undefined, options?: TableData.Index.UniqueOptionsArg | undefined]): {
         tableDataItem: true;
-        columns: Columns_1 extends (string | TableData.Index.ColumnOptionsForColumn<string>)[] ? { [I in keyof Columns_1]: "column" extends keyof Columns_1[I] ? Columns_1[I][keyof Columns_1[I] & "column"] : Columns_1[I]; } : never;
+        columns: Columns_1 extends (string | TableData.Index.ColumnOptionsForColumn<string>)[] ? { [I in keyof Columns_1]: "column" extends keyof Columns_1[I] ? Columns_1[I][keyof Columns_1[I] & "column"] : Columns_1[I]; } : never; /**
+         * Rename a column:
+         *
+         * ```ts
+         * import { change } from '../dbScript';
+         *
+         * change(async (db) => {
+         *   await db.changeTable('table', (t) => ({
+         *     oldColumnName: t.rename('newColumnName'),
+         *   }));
+         * });
+         * ```
+         *
+         * Note that the renaming `ALTER TABLE` is executed before the rest of alterations,
+         * so if you're also adding a new constraint on this column inside the same `changeTable`,
+         * refer to it with a new name.
+         *
+         * @param name
+         */
         name: string extends Name_1 ? never : Name_1;
     };
     index(columns: (string | TableData.Index.ColumnOrExpressionOptions<string>)[], ...args: [options?: TableData.Index.OptionsArg | undefined] | [name?: string | undefined, options?: TableData.Index.OptionsArg | undefined]): pqb.TableDataItem;

package/dist/index.js

@@ -812,6 +812,25 @@ const tableChangeMethods = __spreadProps$5(__spreadValues$7(__spreadValues$7({},
   comment(comment) {
     return { type: "change", from: { comment: null }, to: { comment } };
   },
+  /**
+   * Rename a column:
+   *
+   * ```ts
+   * import { change } from '../dbScript';
+   *
+   * change(async (db) => {
+   *   await db.changeTable('table', (t) => ({
+   *     oldColumnName: t.rename('newColumnName'),
+   *   }));
+   * });
+   * ```
+   *
+   * Note that the renaming `ALTER TABLE` is executed before the rest of alterations,
+   * so if you're also adding a new constraint on this column inside the same `changeTable`,
+   * refer to it with a new name.
+   *
+   * @param name
+   */
   rename(name) {
     return { type: "rename", name };
   }
@@ -1019,7 +1038,13 @@ const astToQueries = (ast, snakeCase, language) => {
   );
   const tableName = quoteWithSchema(ast);
   if (renameItems.length) {
-    queries.push(alterTableSql(tableName, renameItems, values));
+    queries.push(
+      ...renameItems.map((sql) => ({
+        text: `ALTER TABLE ${tableName}
+  ${sql}`,
+        values
+      }))
+    );
   }
   if (alterTable.length) {
     queries.push(alterTableSql(tableName, alterTable, values));