rake-db 2.17.2 → 2.17.3

package/dist/index.mjs

@@ -1677,6 +1677,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):
    *
@@ -2108,7 +2135,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 = {
@@ -2135,6 +2161,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(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(singleQuote).join(", ")}] to [${toValues.map(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",
@@ -2154,7 +2215,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(singleQuote).join(", ")})`
+    `CREATE TYPE ${quotedName} AS ENUM (${values.map(singleQuote).join(", ")})`
   );
   await migration.adapter.query(sql.join(";\n"));
   for (const t of tables) {
@@ -2167,12 +2228,7 @@ GROUP BY n.nspname, c.relname`
         );
       } catch (err) {
         if (err.code === "22P02") {
-          throw new Error(
-            `Cannot drop ${quotedName} enum values [${ast.values.map(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;
       }
@@ -4806,5 +4862,5 @@ Migrate and rollback common arguments:
   --code false            do not run code updater
 `;
 
-export { Migration, NoMigrationsTableError, RAKE_DB_LOCK_KEY, addOrDropEnumValues, changeCache, createDb, createMigrationInterface, deleteMigratedVersion, dropDb, generate, generateTimeStamp, getDatabaseAndUserFromOptions, getMigratedVersionsMap, makeFileVersion, migrate, migrateOrRollback, migrationConfigDefaults, processRakeDbConfig, rakeDb, rakeDbAliases, redo, renameType, resetDb, rollback, saveMigratedVersion, writeMigrationFile };
+export { Migration, NoMigrationsTableError, RAKE_DB_LOCK_KEY, addOrDropEnumValues, changeCache, changeEnumValues, createDb, createMigrationInterface, deleteMigratedVersion, dropDb, generate, generateTimeStamp, getDatabaseAndUserFromOptions, getMigratedVersionsMap, makeFileVersion, migrate, migrateOrRollback, migrationConfigDefaults, processRakeDbConfig, rakeDb, rakeDbAliases, redo, renameType, resetDb, rollback, saveMigratedVersion, writeMigrationFile };
 //# sourceMappingURL=index.mjs.map