rake-db 2.17.2 → 2.17.3

package/dist/index.d.ts

@@ -653,6 +653,31 @@ declare class Migration<CT extends RakeDbColumnTypes> {
      * @param values - object where keys are for old names, values are for new names
      */
     renameEnumValues(enumName: string, values: RecordString): Promise<void>;
+    /**
+     * Drops the enum and re-creates it with a new set of values.
+     * Before dropping, changes all related column types to text, and after creating changes types back to the enum,
+     * in the same way as [dropEnumValues](/guide/migration-writing.html#addenumvalues,-dropenumvalues) works.
+     *
+     * ```ts
+     * import { change } from '../dbScript';
+     *
+     * change(async (db) => {
+     *   await db.changeEnumValues(
+     *     // can be prefixed with schema: 'public.numbers'
+     *     'numbers',
+     *     // change from:
+     *     ['one', 'two'],
+     *     // change to:
+     *     ['three', 'four'],
+     *   );
+     * });
+     * ```
+     *
+     * @param enumName - target enum name, can be prefixed with schema
+     * @param fromValues - array of values before the change
+     * @param toValues - array of values to set
+     */
+    changeEnumValues(enumName: string, fromValues: string[], toValues: string[]): Promise<void>;
     /**
      * Rename a type (such as enum):
      *
@@ -950,8 +975,9 @@ interface AddEnumValueOptions {
     after?: string;
 }
 declare const addOrDropEnumValues: (migration: Migration<RakeDbColumnTypes>, up: boolean, enumName: string, values: string[], options?: AddEnumValueOptions) => Promise<void>;
+declare const changeEnumValues: (migration: Migration<RakeDbColumnTypes>, enumName: string, fromValues: string[], toValues: string[]) => Promise<void>;
 
-type RakeDbAst = RakeDbAst.Table | RakeDbAst.ChangeTable | RakeDbAst.RenameType | RakeDbAst.Schema | RakeDbAst.Extension | RakeDbAst.Enum | RakeDbAst.EnumValues | RakeDbAst.RenameEnumValues | RakeDbAst.Domain | RakeDbAst.Collation | RakeDbAst.Constraint | RakeDbAst.View;
+type RakeDbAst = RakeDbAst.Table | RakeDbAst.ChangeTable | RakeDbAst.RenameType | RakeDbAst.Schema | RakeDbAst.Extension | RakeDbAst.Enum | RakeDbAst.EnumValues | RakeDbAst.RenameEnumValues | RakeDbAst.ChangeEnumValues | RakeDbAst.Domain | RakeDbAst.Collation | RakeDbAst.Constraint | RakeDbAst.View;
 declare namespace RakeDbAst {
     interface Table extends TableData {
         type: 'table';
@@ -1058,6 +1084,13 @@ declare namespace RakeDbAst {
         name: string;
         values: RecordString;
     }
+    interface ChangeEnumValues {
+        type: 'changeEnumValues';
+        schema?: string;
+        name: string;
+        fromValues: string[];
+        toValues: string[];
+    }
     interface Domain {
         type: 'domain';
         action: 'create' | 'drop';
@@ -1402,4 +1435,4 @@ type RakeDbChangeFn<CT extends RakeDbColumnTypes> = (fn: ChangeCallback<CT>) =>
 declare const rakeDb: RakeDbFn;
 declare const rakeDbAliases: RecordOptionalString;
 
-export { AnyRakeDbConfig, AppCodeUpdater, AppCodeUpdaterParams, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, ConstraintArg, DbMigration, DropMode, InputRakeDbConfig, Migration, MigrationAdapter, MigrationColumnTypes, ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAppliedVersions, RakeDbAst, RakeDbBaseTable, RakeDbChangeFn, RakeDbColumnTypes, RakeDbConfig, RakeDbFn, RakeDbFnReturns, RakeDbLazyFn, RakeDbMigrationId, RakeDbResult, SilentQueries, TableOptions, addOrDropEnumValues, changeCache, createDb, createMigrationInterface, deleteMigratedVersion, dropDb, generate, generateTimeStamp, getDatabaseAndUserFromOptions, getMigratedVersionsMap, makeFileVersion, migrate, migrateOrRollback, migrationConfigDefaults, processRakeDbConfig, rakeDb, rakeDbAliases, redo, renameType, resetDb, rollback, saveMigratedVersion, writeMigrationFile };
+export { AnyRakeDbConfig, AppCodeUpdater, AppCodeUpdaterParams, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, ConstraintArg, DbMigration, DropMode, InputRakeDbConfig, Migration, MigrationAdapter, MigrationColumnTypes, ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAppliedVersions, RakeDbAst, RakeDbBaseTable, RakeDbChangeFn, RakeDbColumnTypes, RakeDbConfig, RakeDbFn, RakeDbFnReturns, RakeDbLazyFn, RakeDbMigrationId, RakeDbResult, SilentQueries, TableOptions, addOrDropEnumValues, changeCache, changeEnumValues, createDb, createMigrationInterface, deleteMigratedVersion, dropDb, generate, generateTimeStamp, getDatabaseAndUserFromOptions, getMigratedVersionsMap, makeFileVersion, migrate, migrateOrRollback, migrationConfigDefaults, processRakeDbConfig, rakeDb, rakeDbAliases, redo, renameType, resetDb, rollback, saveMigratedVersion, writeMigrationFile };

package/dist/index.js

@@ -1679,6 +1679,33 @@ class Migration {
       );
     }
   }
+  /**
+   * Drops the enum and re-creates it with a new set of values.
+   * Before dropping, changes all related column types to text, and after creating changes types back to the enum,
+   * in the same way as [dropEnumValues](/guide/migration-writing.html#addenumvalues,-dropenumvalues) works.
+   *
+   * ```ts
+   * import { change } from '../dbScript';
+   *
+   * change(async (db) => {
+   *   await db.changeEnumValues(
+   *     // can be prefixed with schema: 'public.numbers'
+   *     'numbers',
+   *     // change from:
+   *     ['one', 'two'],
+   *     // change to:
+   *     ['three', 'four'],
+   *   );
+   * });
+   * ```
+   *
+   * @param enumName - target enum name, can be prefixed with schema
+   * @param fromValues - array of values before the change
+   * @param toValues - array of values to set
+   */
+  changeEnumValues(enumName, fromValues, toValues) {
+    return changeEnumValues(this, enumName, fromValues, toValues);
+  }
   /**
    * Rename a type (such as enum):
    *
@@ -2110,7 +2137,6 @@ const renameType = async (migration, from, to, table) => {
 };
 const addOrDropEnumValues = async (migration, up, enumName, values, options) => {
   var _a;
-  const defaultSchema = migration.adapter.schema;
   const [schema, name] = getSchemaAndTableFromName(enumName);
   const quotedName = quoteTable(schema, name);
   const ast = {
@@ -2137,6 +2163,41 @@ const addOrDropEnumValues = async (migration, up, enumName, values, options) =>
     `SELECT unnest(enum_range(NULL::${quotedName}))::text value`
   );
   const existingValues = valuesRows.map((r) => r.value);
+  await recreateEnum(
+    migration,
+    ast,
+    existingValues.filter((v) => !ast.values.includes(v)),
+    (quotedName2, table, column) => `Cannot drop ${quotedName2} enum values [${ast.values.map(orchidCore.singleQuote).join(
+      ", "
+    )}]: table ${table} has a row with such value in the column "${column}"`
+  );
+};
+const changeEnumValues = async (migration, enumName, fromValues, toValues) => {
+  const [schema, name] = getSchemaAndTableFromName(enumName);
+  if (!migration.up) {
+    const values = fromValues;
+    fromValues = toValues;
+    toValues = values;
+  }
+  const ast = {
+    type: "changeEnumValues",
+    schema,
+    name,
+    fromValues,
+    toValues
+  };
+  await recreateEnum(
+    migration,
+    ast,
+    ast.toValues,
+    (quotedName, table, column) => `Cannot change ${quotedName} enum values from [${fromValues.map(orchidCore.singleQuote).join(", ")}] to [${toValues.map(orchidCore.singleQuote).join(
+      ", "
+    )}]: table ${table} has a row with removed value in the column "${column}"`
+  );
+};
+const recreateEnum = async (migration, { schema, name }, values, errorMessage) => {
+  const defaultSchema = migration.adapter.schema;
+  const quotedName = quoteTable(schema, name);
   const { rows: tables } = await migration.adapter.query(
     `SELECT n.nspname AS "schema",
   c.relname AS "table",
@@ -2156,7 +2217,7 @@ GROUP BY n.nspname, c.relname`
   );
   sql.push(
     `DROP TYPE ${quotedName}`,
-    `CREATE TYPE ${quotedName} AS ENUM (${existingValues.filter((v) => !ast.values.includes(v)).map(orchidCore.singleQuote).join(", ")})`
+    `CREATE TYPE ${quotedName} AS ENUM (${values.map(orchidCore.singleQuote).join(", ")})`
   );
   await migration.adapter.query(sql.join(";\n"));
   for (const t of tables) {
@@ -2169,12 +2230,7 @@ GROUP BY n.nspname, c.relname`
         );
       } catch (err) {
         if (err.code === "22P02") {
-          throw new Error(
-            `Cannot drop ${quotedName} enum values [${ast.values.map(orchidCore.singleQuote).join(
-              ", "
-            )}]: table ${table} has a row with such value in the column "${c}"`,
-            { cause: err }
-          );
+          throw new Error(errorMessage(quotedName, table, c), { cause: err });
         }
         throw err;
       }
@@ -4813,6 +4869,7 @@ exports.NoMigrationsTableError = NoMigrationsTableError;
 exports.RAKE_DB_LOCK_KEY = RAKE_DB_LOCK_KEY;
 exports.addOrDropEnumValues = addOrDropEnumValues;
 exports.changeCache = changeCache;
+exports.changeEnumValues = changeEnumValues;
 exports.createDb = createDb;
 exports.createMigrationInterface = createMigrationInterface;
 exports.deleteMigratedVersion = deleteMigratedVersion;