rake-db 2.3.26 → 2.3.28

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # rake-db
 
+## 2.3.28
+
+### Patch Changes
+
+- Support enum in rake-db
+
 ## 2.3.26
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as pqb from 'pqb';
-import { EmptyObject, RawExpression, ColumnType, ColumnTypes, EnumColumn, raw, ColumnsShape, DbResult, DefaultColumnTypes, TransactionAdapter, AdapterOptions, TextColumn, MaybeArray, IndexColumnOptions, IndexOptions, ForeignKeyOptions, QueryLogObject, NoPrimaryKeyOption, TableData, SingleColumnIndexOptions, QueryLogOptions } from 'pqb';
+import { EmptyObject, RawExpression, ColumnType, EnumColumn, ColumnTypes, raw, ColumnsShape, DbResult, DefaultColumnTypes, TransactionAdapter, AdapterOptions, TextColumn, MaybeArray, IndexColumnOptions, IndexOptions, ForeignKeyOptions, QueryLogObject, NoPrimaryKeyOption, TableData, SingleColumnIndexOptions, QueryLogOptions } from 'pqb';
 
 declare function add(item: ColumnType, options?: {
     dropMode?: DropMode;
@@ -15,7 +15,6 @@ declare type ChangeOptions = {
 };
 declare type TableChangeMethods = typeof tableChangeMethods;
 declare const tableChangeMethods: {
-    raw: (sql: string, values?: false | Record<string, unknown> | undefined) => RawExpression<ColumnType<unknown, pqb.BaseOperators, unknown>>;
     add: typeof add;
     drop: typeof add;
     change(from: ColumnType | Change, to: ColumnType | Change, options?: ChangeOptions): Change;
@@ -24,6 +23,8 @@ declare const tableChangeMethods: {
     nonNullable(): Change;
     comment(comment: string | null): Change;
     rename(name: string): RakeDbAst.ChangeTableItem.Rename;
+    raw: (sql: string, values?: false | Record<string, unknown> | undefined) => RawExpression<ColumnType<unknown, pqb.BaseOperators, unknown>>;
+    enum: (name: string) => EnumColumn<string, [string, ...string[]]>;
 };
 declare type TableChanger = MigrationColumnTypes & TableChangeMethods;
 declare type TableChangeData = Record<string, RakeDbAst.ChangeTableItem.Column | RakeDbAst.ChangeTableItem.Rename | Change | EmptyObject>;
@@ -528,12 +529,14 @@ declare const resetDb: (arg: MaybeArray<AdapterOptions>, config: RakeDbConfig) =
 declare const writeMigrationFile: (config: RakeDbConfig, name: string, content: string) => Promise<void>;
 declare const generate: (config: RakeDbConfig, args: string[]) => Promise<void>;
 
-declare const migrate: (options: MaybeArray<AdapterOptions>, config: RakeDbConfig, args?: string[]) => Promise<void>;
-declare const rollback: (options: MaybeArray<AdapterOptions>, config: RakeDbConfig, args?: string[]) => Promise<void>;
-
 declare type ChangeCallback = (db: Migration, up: boolean) => Promise<void>;
 declare const change: (fn: ChangeCallback) => void;
 
+declare const migrateOrRollback: (options: MaybeArray<AdapterOptions>, config: RakeDbConfig, args: string[], up: boolean) => Promise<void>;
+declare const changeCache: Record<string, ChangeCallback[] | undefined>;
+declare const migrate: (options: MaybeArray<AdapterOptions>, config: RakeDbConfig, args?: string[]) => Promise<void>;
+declare const rollback: (options: MaybeArray<AdapterOptions>, config: RakeDbConfig, args?: string[]) => Promise<void>;
+
 declare const rakeDb: (options: MaybeArray<AdapterOptions>, partialConfig?: Partial<RakeDbConfig>, args?: string[]) => Promise<void>;
 
-export { AppCodeUpdater, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, DropMode, JoinTableOptions, Migration, MigrationBase, MigrationColumnTypes, RakeDbAst, RakeDbConfig, TableOptions, change, createDb, createMigrationInterface, dropDb, generate, migrate, rakeDb, resetDb, rollback, runCodeUpdater, writeMigrationFile };
+export { AppCodeUpdater, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, DropMode, JoinTableOptions, Migration, MigrationBase, MigrationColumnTypes, RakeDbAst, RakeDbConfig, TableOptions, change, changeCache, createDb, createMigrationInterface, dropDb, generate, migrate, migrateOrRollback, rakeDb, resetDb, rollback, runCodeUpdater, writeMigrationFile };

package/dist/index.js

@@ -252,25 +252,27 @@ const quoteSchemaTable = ({
 }) => {
   return pqb.singleQuote(schema ? `${schema}.${name}` : name);
 };
+const makePopulateEnumQuery = (item) => {
+  const [schema, name] = getSchemaAndTableFromName(item.enumName);
+  return {
+    text: `SELECT unnest(enum_range(NULL::${quoteWithSchema({
+      schema,
+      name
+    })}))::text`,
+    then(result) {
+      item.options.push(...result.rows.map(([value]) => value));
+    }
+  };
+};
 
-let currentMigration;
-let currentPromise;
-let currentUp = true;
-let currentChangeCallback;
+const currentChanges = [];
 const change = (fn) => {
-  if (!currentMigration)
-    throw new Error("Database instance is not set");
-  currentPromise = fn(currentMigration, currentUp);
-  currentChangeCallback = fn;
-};
-const setCurrentMigration = (db) => {
-  currentMigration = db;
+  currentChanges.push(fn);
 };
-const setCurrentMigrationUp = (up) => {
-  currentUp = up;
+const clearChanges = () => {
+  currentChanges.length = 0;
 };
-const getCurrentPromise = () => currentPromise;
-const getCurrentChangeCallback = () => currentChangeCallback;
+const getCurrentChanges = () => currentChanges;
 
 var __defProp$5 = Object.defineProperty;
 var __defProps$4 = Object.defineProperties;
@@ -461,6 +463,16 @@ const primaryKeyToSql = (primaryKey) => {
   )})`;
 };
 
+const tableMethods = {
+  raw: pqb.raw,
+  enum: (name) => new pqb.EnumColumn(name, [])
+};
+
+class RakeDbError extends Error {
+}
+class NoPrimaryKey extends RakeDbError {
+}
+
 var __defProp$4 = Object.defineProperty;
 var __defProps$3 = Object.defineProperties;
 var __getOwnPropDescs$3 = Object.getOwnPropertyDescriptors;
@@ -480,9 +492,19 @@ var __spreadValues$4 = (a, b) => {
   return a;
 };
 var __spreadProps$3 = (a, b) => __defProps$3(a, __getOwnPropDescs$3(b));
-const types = Object.assign(Object.create(pqb.columnTypes), {
-  raw: pqb.raw
-});
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$4.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$4)
+    for (var prop of __getOwnPropSymbols$4(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$4.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+const types = Object.assign(Object.create(pqb.columnTypes), tableMethods);
 const createTable$1 = async (migration, up, tableName, options, fn) => {
   const shape = pqb.getColumnTypes(types, fn);
   const tableData = pqb.getTableData();
@@ -496,8 +518,10 @@ const createTable$1 = async (migration, up, tableName, options, fn) => {
   );
   validatePrimaryKey(ast);
   const queries = astToQueries$1(ast);
-  for (const query of queries) {
-    await migration.adapter.query(query);
+  for (const _a of queries) {
+    const _b = _a, { then } = _b, query = __objRest(_b, ["then"]);
+    const result = await migration.adapter.arrays(query);
+    then == null ? void 0 : then(result);
   }
   await runCodeUpdater(migration, ast);
 };
@@ -535,23 +559,31 @@ const validatePrimaryKey = (ast) => {
       }
     }
     if (!hasPrimaryKey) {
-      const message = `Table ${ast.name} has no primary key`;
+      const error = new NoPrimaryKey(
+        `Table ${ast.name} has no primary key.
+You can suppress this error by setting { noPrimaryKey: true } after a table name.`
+      );
       if (ast.noPrimaryKey === "error") {
-        throw new Error(message);
+        throw error;
       } else {
-        console.warn(message);
+        console.warn(error.message);
       }
     }
   }
 };
 const astToQueries$1 = (ast) => {
+  const queries = [];
+  for (const key in ast.shape) {
+    const item = ast.shape[key];
+    if (!(item instanceof pqb.EnumColumn))
+      continue;
+    queries.push(makePopulateEnumQuery(item));
+  }
   if (ast.action === "drop") {
-    return [
-      {
-        text: `DROP TABLE ${quoteWithSchema(ast)}${ast.dropMode ? ` ${ast.dropMode}` : ""}`,
-        values: []
-      }
-    ];
+    queries.push({
+      text: `DROP TABLE ${quoteWithSchema(ast)}${ast.dropMode ? ` ${ast.dropMode}` : ""}`
+    });
+    return queries;
   }
   const lines = [];
   const values = [];
@@ -573,7 +605,7 @@ const astToQueries$1 = (ast) => {
   ${constraintToSql(ast, true, foreignKey)}`);
   });
   indexes.push(...ast.indexes);
-  const result = [
+  queries.push(
     {
       text: `CREATE TABLE ${quoteWithSchema(ast)} (${lines.join(",")}
 )`,
@@ -581,14 +613,13 @@ const astToQueries$1 = (ast) => {
     },
     ...indexesToQuery(true, ast, indexes),
     ...commentsToQuery(ast, comments)
-  ];
+  );
   if (ast.comment) {
-    result.push({
-      text: `COMMENT ON TABLE ${quoteWithSchema(ast)} IS ${pqb.quote(ast.comment)}`,
-      values: []
+    queries.push({
+      text: `COMMENT ON TABLE ${quoteWithSchema(ast)} IS ${pqb.quote(ast.comment)}`
     });
   }
-  return result;
+  return queries;
 };
 
 var __defProp$3 = Object.defineProperty;
@@ -687,8 +718,7 @@ const columnTypeToColumnChange = (item) => {
   }
   return item.to;
 };
-const tableChangeMethods = {
-  raw: pqb.raw,
+const tableChangeMethods = __spreadProps$2(__spreadValues$3({}, tableMethods), {
   add,
   drop,
   change(from, to, options) {
@@ -721,8 +751,9 @@ const tableChangeMethods = {
   rename(name) {
     return { type: "rename", name };
   }
-};
+});
 const changeTable = async (migration, up, tableName, options, fn) => {
+  var _a;
   pqb.resetTableData();
   resetChangeTableData();
   const tableChanger = Object.create(pqb.columnTypes);
@@ -731,7 +762,8 @@ const changeTable = async (migration, up, tableName, options, fn) => {
   const ast = makeAst(up, tableName, changeData, changeTableData, options);
   const queries = astToQueries(ast);
   for (const query of queries) {
-    await migration.adapter.query(query);
+    const result = await migration.adapter.arrays(query);
+    (_a = query.then) == null ? void 0 : _a.call(query, result);
   }
   await runCodeUpdater(migration, ast);
 };
@@ -763,11 +795,10 @@ const makeAst = (up, name, changeData, changeTableData2, options) => {
 };
 const astToQueries = (ast) => {
   var _a, _b, _c, _d, _e, _f, _g, _h, _i;
-  const result = [];
+  const queries = [];
   if (ast.comment !== void 0) {
-    result.push({
-      text: `COMMENT ON TABLE ${quoteWithSchema(ast)} IS ${pqb.quote(ast.comment)}`,
-      values: []
+    queries.push({
+      text: `COMMENT ON TABLE ${quoteWithSchema(ast)} IS ${pqb.quote(ast.comment)}`
     });
   }
   const addPrimaryKeys = ast.add.primaryKey ? __spreadValues$3({}, ast.add.primaryKey) : {
@@ -778,6 +809,12 @@ const astToQueries = (ast) => {
   };
   for (const key in ast.shape) {
     const item = ast.shape[key];
+    if ("item" in item) {
+      const { item: column } = item;
+      if (column instanceof pqb.EnumColumn) {
+        queries.push(makePopulateEnumQuery(column));
+      }
+    }
     if (item.type === "add") {
       if (item.item.isPrimaryKey) {
         addPrimaryKeys.columns.push(key);
@@ -787,6 +824,12 @@ const astToQueries = (ast) => {
         dropPrimaryKeys.columns.push(key);
       }
     } else if (item.type === "change") {
+      if (item.from.column instanceof pqb.EnumColumn) {
+        queries.push(makePopulateEnumQuery(item.from.column));
+      }
+      if (item.to.column instanceof pqb.EnumColumn) {
+        queries.push(makePopulateEnumQuery(item.to.column));
+      }
       if (item.from.primaryKey) {
         dropPrimaryKeys.columns.push(key);
         dropPrimaryKeys.change = true;
@@ -929,16 +972,16 @@ const astToQueries = (ast) => {
     )
   );
   if (alterTable.length) {
-    result.push({
+    queries.push({
       text: `ALTER TABLE ${quoteWithSchema(ast)}
   ${alterTable.join(",\n  ")}`,
       values
     });
   }
-  result.push(...indexesToQuery(false, ast, dropIndexes));
-  result.push(...indexesToQuery(true, ast, addIndexes));
-  result.push(...commentsToQuery(ast, comments));
-  return result;
+  queries.push(...indexesToQuery(false, ast, dropIndexes));
+  queries.push(...indexesToQuery(true, ast, addIndexes));
+  queries.push(...commentsToQuery(ast, comments));
+  return queries;
 };
 
 var __defProp$2 = Object.defineProperty;
@@ -1078,10 +1121,10 @@ class MigrationBase {
     return createExtension$1(this, !this.up, name, options);
   }
   createEnum(name, values, options) {
-    return createEnum(this, this.up, name, values, options);
+    return createEnum$1(this, this.up, name, values, options);
   }
   dropEnum(name, values, options) {
-    return createEnum(this, !this.up, name, values, options);
+    return createEnum$1(this, !this.up, name, values, options);
   }
   async tableExists(tableName) {
     return queryExists(this, {
@@ -1158,7 +1201,7 @@ const createExtension$1 = async (migration, up, name, options) => {
   await migration.adapter.query(query);
   await runCodeUpdater(migration, ast);
 };
-const createEnum = async (migration, up, name, values, options = {}) => {
+const createEnum$1 = async (migration, up, name, values, options = {}) => {
   const [schema, enumName] = getSchemaAndTableFromName(name);
   const ast = __spreadValues$2({
     type: "enum",
@@ -1167,17 +1210,14 @@ const createEnum = async (migration, up, name, values, options = {}) => {
     name: enumName,
     values
   }, options);
-  let text;
+  let query;
   const quotedName = quoteWithSchema(ast);
   if (ast.action === "create") {
-    text = `CREATE TYPE ${quotedName} AS ENUM (${values.map((_, i) => `$${i + 1}`).join(", ")})`;
+    query = `CREATE TYPE ${quotedName} AS ENUM (${values.map(pqb.quote).join(", ")})`;
   } else {
-    text = `DROP TYPE${ast.dropIfExists ? " IF EXISTS" : ""} ${quotedName}${ast.cascade ? " CASCADE" : ""}`;
+    query = `DROP TYPE${ast.dropIfExists ? " IF EXISTS" : ""} ${quotedName}${ast.cascade ? " CASCADE" : ""}`;
   }
-  await migration.adapter.query({
-    text,
-    values
-  });
+  await migration.adapter.query(query);
   await runCodeUpdater(migration, ast);
 };
 const queryExists = (db, sql) => {
@@ -1275,16 +1315,16 @@ const processMigration = async (db, up, file, config, options, appCodeUpdaterCac
       options,
       appCodeUpdaterCache
     );
-    setCurrentMigration(db2);
-    setCurrentMigrationUp(up);
-    const callback = changeCache[file.path];
-    if (callback) {
-      change(callback);
-    } else {
+    clearChanges();
+    let changes = changeCache[file.path];
+    if (!changes) {
       await config.import(url.pathToFileURL(file.path).pathname);
-      changeCache[file.path] = getCurrentChangeCallback();
+      changes = getCurrentChanges();
+      changeCache[file.path] = changes;
+    }
+    for (const fn of up ? changes : changes.reverse()) {
+      await fn(db2, up);
     }
-    await getCurrentPromise();
     await (up ? saveMigratedVersion : removeMigratedVersion)(
       db2.adapter,
       file.version,
@@ -1769,6 +1809,20 @@ JOIN pg_catalog.pg_namespace n ON n.oid = extnamespace
     );
     return rows;
   }
+  async getEnums() {
+    const { rows } = await this.db.query(
+      `SELECT
+  n.nspname as "schemaName",
+  t.typname as name,
+  json_agg(e.enumlabel) as values
+FROM pg_type t
+JOIN pg_enum e ON t.oid = e.enumtypid
+JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace
+WHERE ${filterSchema("n.nspname")}
+GROUP BY n.nspname, t.typname`
+    );
+    return rows;
+  }
 }
 
 var __defProp = Object.defineProperty;
@@ -1835,6 +1889,24 @@ const structureToAst = async (db) => {
     }
   }
   const outerFKeys = [];
+  for (const it of data.extensions) {
+    ast.push({
+      type: "extension",
+      action: "create",
+      name: it.name,
+      schema: it.schemaName === "public" ? void 0 : it.schemaName,
+      version: it.version
+    });
+  }
+  for (const it of data.enums) {
+    ast.push({
+      type: "enum",
+      action: "create",
+      name: it.name,
+      schema: it.schemaName === "public" ? void 0 : it.schemaName,
+      values: it.values
+    });
+  }
   for (const key in pendingTables) {
     const innerFKeys = [];
     const { table } = pendingTables[key];
@@ -1858,15 +1930,6 @@ const structureToAst = async (db) => {
       tableName: fkey.tableName
     }));
   }
-  for (const it of data.extensions) {
-    ast.push({
-      type: "extension",
-      action: "create",
-      name: it.name,
-      schema: it.schemaName === "public" ? void 0 : it.schemaName,
-      version: it.version
-    });
-  }
   return ast;
 };
 const getData = async (db) => {
@@ -1877,7 +1940,8 @@ const getData = async (db) => {
     primaryKeys,
     indexes,
     foreignKeys,
-    extensions
+    extensions,
+    enums
   ] = await Promise.all([
     db.getSchemas(),
     db.getTables(),
@@ -1885,7 +1949,8 @@ const getData = async (db) => {
     db.getPrimaryKeys(),
     db.getIndexes(),
     db.getForeignKeys(),
-    db.getExtensions()
+    db.getExtensions(),
+    db.getEnums()
   ]);
   return {
     schemas,
@@ -1894,7 +1959,8 @@ const getData = async (db) => {
     primaryKeys,
     indexes,
     foreignKeys,
-    extensions
+    extensions,
+    enums
   };
 };
 const makeBelongsToTable = (schema, table) => (item) => item.schemaName === schema && item.tableName === table;
@@ -2026,32 +2092,56 @@ const foreignKeyToAst = (fkey) => ({
 });
 
 const astToMigration = (ast) => {
-  const code = [];
+  const first = [];
+  const tables = [];
+  const foreignKeys = [];
   for (const item of ast) {
     if (item.type === "schema" && item.action === "create") {
-      code.push(createSchema(item));
+      first.push(createSchema(item));
     } else if (item.type === "extension" && item.action === "create") {
-      if (code.length)
-        code.push([]);
-      code.push(...createExtension(item));
+      if (first.length)
+        first.push([]);
+      first.push(...createExtension(item));
+    } else if (item.type === "enum" && item.action === "create") {
+      if (first.length)
+        first.push([]);
+      first.push(...createEnum(item));
     } else if (item.type === "table" && item.action === "create") {
-      if (code.length)
-        code.push([]);
-      code.push(...createTable(item));
+      tables.push(createTable(item));
     } else if (item.type === "foreignKey") {
-      if (code.length)
-        code.push([]);
-      code.push(...createForeignKey(item));
+      if (foreignKeys.length)
+        foreignKeys.push([]);
+      foreignKeys.push(...createForeignKey(item));
     }
   }
-  if (!code.length)
+  if (!first.length && !tables.length && !foreignKeys.length)
     return;
-  return `import { change } from 'rake-db';
-
+  let code = `import { change } from 'rake-db';
+`;
+  if (first.length) {
+    code += `
 change(async (db) => {
-${pqb.codeToString(code, "  ", "  ")}
+${pqb.codeToString(first, "  ", "  ")}
 });
 `;
+  }
+  if (tables.length) {
+    for (const table of tables) {
+      code += `
+change(async (db) => {
+${pqb.codeToString(table, "  ", "  ")}
+});
+`;
+    }
+  }
+  if (foreignKeys.length) {
+    code += `
+change(async (db) => {
+${pqb.codeToString(foreignKeys, "  ", "  ")}
+});
+`;
+  }
+  return code;
 };
 const createSchema = (ast) => {
   return `await db.createSchema(${pqb.singleQuote(ast.name)});`;
@@ -2068,7 +2158,19 @@ const createExtension = (ast) => {
     }
     pqb.addCode(code, "}");
   }
-  pqb.addCode(code, ")");
+  pqb.addCode(code, ");");
+  return code;
+};
+const createEnum = (ast) => {
+  const code = [
+    `await db.createEnum(${pqb.singleQuote(ast.name)}, [${ast.values.map(pqb.singleQuote).join(", ")}]`
+  ];
+  if (ast.schema) {
+    pqb.addCode(code, ", {");
+    code.push([`schema: ${pqb.singleQuote(ast.schema)},`]);
+    pqb.addCode(code, "}");
+  }
+  pqb.addCode(code, ");");
   return code;
 };
 const createTable = (ast) => {
@@ -2135,24 +2237,32 @@ const rakeDb = async (options, partialConfig = {}, args = process.argv.slice(2))
   var _a;
   const config = processRakeDbConfig(partialConfig);
   const command = (_a = args[0]) == null ? void 0 : _a.split(":")[0];
-  if (command === "create") {
-    await createDb(options, config);
-  } else if (command === "drop") {
-    await dropDb(options);
-  } else if (command === "reset") {
-    await resetDb(options, config);
-  } else if (command === "migrate") {
-    await migrate(options, config, args.slice(1));
-  } else if (command === "rollback") {
-    await rollback(options, config, args.slice(1));
-  } else if (command === "g" || command === "generate") {
-    await generate(config, args.slice(1));
-  } else if (command === "pull") {
-    await pullDbStructure(pqb.toArray(options)[0], config);
-  } else if (config.commands[command]) {
-    await config.commands[command](pqb.toArray(options), config, args.slice(1));
-  } else {
-    printHelp();
+  try {
+    if (command === "create") {
+      await createDb(options, config);
+    } else if (command === "drop") {
+      await dropDb(options);
+    } else if (command === "reset") {
+      await resetDb(options, config);
+    } else if (command === "migrate") {
+      await migrate(options, config, args.slice(1));
+    } else if (command === "rollback") {
+      await rollback(options, config, args.slice(1));
+    } else if (command === "g" || command === "generate") {
+      await generate(config, args.slice(1));
+    } else if (command === "pull") {
+      await pullDbStructure(pqb.toArray(options)[0], config);
+    } else if (config.commands[command]) {
+      await config.commands[command](pqb.toArray(options), config, args.slice(1));
+    } else {
+      printHelp();
+    }
+  } catch (err) {
+    if (err instanceof RakeDbError) {
+      console.error(err.message);
+      process.exit(1);
+    }
+    throw err;
   }
 };
 const printHelp = () => console.log(
@@ -2195,11 +2305,13 @@ Generate arguments:
 
 exports.MigrationBase = MigrationBase;
 exports.change = change;
+exports.changeCache = changeCache;
 exports.createDb = createDb;
 exports.createMigrationInterface = createMigrationInterface;
 exports.dropDb = dropDb;
 exports.generate = generate;
 exports.migrate = migrate;
+exports.migrateOrRollback = migrateOrRollback;
 exports.rakeDb = rakeDb;
 exports.resetDb = resetDb;
 exports.rollback = rollback;