rake-db 2.27.6 → 2.27.8

package/dist/index.d.ts

@@ -254,14 +254,14 @@ declare const tableChangeMethods: {
         columns: Columns;
         name: string extends Name ? never : Name;
     };
-    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]): {
+    unique<Columns_1 extends [string | TableData.Index.ColumnOrExpressionOptions<string>, ...(string | TableData.Index.ColumnOrExpressionOptions<string>)[]], Name_1 extends string>(columns: Columns_1, options?: TableData.Index.UniqueOptionsArg<Name_1> | 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;
         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.NonUniqDataItem;
-    searchIndex(columns: (string | TableData.Index.ColumnOrExpressionOptions<string>)[], ...args: [options?: TableData.Index.TsVectorArg | undefined] | [name?: string | undefined, options?: TableData.Index.TsVectorArg | undefined]): pqb.NonUniqDataItem;
-    exclude(columns: TableData.Exclude.ColumnOrExpressionOptions<string>[], ...args: [options?: TableData.Exclude.Options | undefined] | [name?: string | undefined, options?: TableData.Exclude.Options | undefined]): pqb.NonUniqDataItem;
+    index(columns: (string | TableData.Index.ColumnOrExpressionOptions<string>)[], options?: TableData.Index.OptionsArg | undefined): pqb.NonUniqDataItem;
+    searchIndex(columns: (string | TableData.Index.ColumnOrExpressionOptions<string>)[], options?: TableData.Index.TsVectorArg | undefined): pqb.NonUniqDataItem;
+    exclude(columns: TableData.Exclude.ColumnOrExpressionOptions<string>[], options?: TableData.Exclude.Options | undefined): pqb.NonUniqDataItem;
     foreignKey<ForeignTable extends string | (() => orchid_core.ForeignKeyTable), ForeignColumns extends ForeignTable extends () => orchid_core.ForeignKeyTable ? [orchid_core.ColumnNameOfTable<ReturnType<ForeignTable>>, ...orchid_core.ColumnNameOfTable<ReturnType<ForeignTable>>[]] : [string, ...string[]]>(columns: [string, ...string[]], fnOrTable: ForeignTable, foreignColumns: ForeignColumns, options?: TableData.References.Options | undefined): pqb.NonUniqDataItem;
     check(check: RawSQLBase<orchid_core.QueryColumn<unknown, any>, unknown>, name?: string | undefined): pqb.NonUniqDataItem;
     sql: pqb.SqlFn;
@@ -491,6 +491,7 @@ interface RakeDbRenameMigrationsInput {
     map: RakeDbRenameMigrationsMap;
 }
 declare const migrationConfigDefaults: RakeDbBaseConfig<ColumnSchemaConfig>;
+declare const processRakeDbConfig: <SchemaConfig extends ColumnSchemaConfig<orchid_core.ColumnTypeBase<orchid_core.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any, orchid_core.ColumnDataBase>>, CT>(config: InputRakeDbConfig<SchemaConfig, CT>) => RakeDbConfig<SchemaConfig, CT>;
 
 type DropMode = 'CASCADE' | 'RESTRICT';
 type TableOptions = {
@@ -771,17 +772,17 @@ declare class Migration<CT> {
      *
      * @param tableName - name of the table to add the index for
      * @param columns - indexed columns
-     * @param args - index options, or an index name and then options
+     * @param args - index options
      */
-    addIndex(tableName: string, columns: (string | TableData.Index.ColumnOrExpressionOptions<string>)[], ...args: [options?: TableData.Index.OptionsArg] | [name?: string, options?: TableData.Index.OptionsArg]): Promise<void>;
+    addIndex(tableName: string, columns: (string | TableData.Index.ColumnOrExpressionOptions)[], ...args: [options?: TableData.Index.OptionsArg]): Promise<void>;
     /**
      * Drop the schema, create it on rollback. See {@link addIndex}.
      *
      * @param tableName - name of the table to add the index for
      * @param columns - indexed columns
-     * @param args - index options, or an index name and then options
+     * @param args - index options
      */
-    dropIndex(tableName: string, columns: (string | TableData.Index.ColumnOrExpressionOptions<string>)[], ...args: [options?: TableData.Index.OptionsArg] | [name?: string, options?: TableData.Index.OptionsArg]): Promise<void>;
+    dropIndex(tableName: string, columns: (string | TableData.Index.ColumnOrExpressionOptions)[], ...args: [options?: TableData.Index.OptionsArg]): Promise<void>;
     /**
      * Rename index:
      *
@@ -1493,6 +1494,8 @@ interface RakeDbChangeFnWithPromise<CT> extends RakeDbChangeFn<CT> {
  * @param args - optionally provide an array of cli args. Default is `process.argv.slice(2)`.
  */
 declare const rakeDbWithAdapters: RakeDbFn<AdapterBase[]>;
+declare const makeChange: (config: RakeDbConfig<ColumnSchemaConfig, unknown>) => (fn: ChangeCallback<unknown>) => MigrationChange;
+declare const runCommand: <SchemaConfig extends ColumnSchemaConfig<orchid_core.ColumnTypeBase<orchid_core.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any, orchid_core.ColumnDataBase>>, CT>(adapters: AdapterBase[], config: RakeDbConfig<SchemaConfig, CT>, args?: string[]) => Promise<RakeDbResult>;
 interface RakeDbCommand {
     run(adapters: AdapterBase[], config: AnyRakeDbConfig, args: string[]): MaybePromise<unknown>;
     help: string;
@@ -1753,5 +1756,12 @@ interface OrmParam {
 }
 type UnknownPromiseFns = (() => Promise<unknown>)[];
 declare const migrateFiles: (db: OrmParam, files: UnknownPromiseFns) => Promise<void>;
+declare const makeMigrateAdapter: (config?: Partial<MigrateFnConfig>) => ((adapter: AdapterBase, params?: {
+    count?: number;
+    force?: boolean;
+}) => Promise<void>);
+
+declare class RakeDbError extends Error {
+}
 
-export { type AnyRakeDbConfig, type ChangeCallback, type DbMigration, DbStructure, type InputRakeDbConfigBase, type IntrospectedStructure, RakeDbAst, type RakeDbChangeFn, type RakeDbChangeFnWithPromise, type RakeDbConfig, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, astToMigration, concatSchemaAndName, createMigrationInterface, dbColumnToAst, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getExcludeName, getIndexName, getSchemaAndTableFromName, instantiateDbColumn, introspectDbSchema, makeDomainsMap, makeFileVersion, makeStructureToAstCtx, migrate, migrateAndClose, migrateFiles, migrationConfigDefaults, promptSelect, rakeDbCommands, rakeDbWithAdapters, saveMigratedVersion, structureToAst, tableToAst, writeMigrationFile };
+export { type AnyRakeDbConfig, type ChangeCallback, type DbMigration, DbStructure, type InputRakeDbConfig, type InputRakeDbConfigBase, type IntrospectedStructure, type MigrateFnConfig, RakeDbAst, type RakeDbChangeFn, type RakeDbChangeFnWithPromise, type RakeDbConfig, RakeDbError, type RakeDbFn, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, astToMigration, concatSchemaAndName, createMigrationInterface, dbColumnToAst, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getExcludeName, getIndexName, getSchemaAndTableFromName, instantiateDbColumn, introspectDbSchema, makeChange, makeDomainsMap, makeFileVersion, makeMigrateAdapter, makeStructureToAstCtx, migrate, migrateAndClose, migrateFiles, migrationConfigDefaults, processRakeDbConfig, promptSelect, rakeDbCommands, rakeDbWithAdapters, runCommand, saveMigratedVersion, structureToAst, tableToAst, writeMigrationFile };

package/dist/index.js

@@ -420,7 +420,7 @@ const getIndexOrExcludeMainOptions = (tableName, item, getName, snakeCase) => {
   return {
     columns,
     include,
-    name: item.name || getName(tableName, columns)
+    name: item.options?.name || getName(tableName, columns)
   };
 };
 const commentsToQuery = (schemaTable, comments) => {
@@ -1512,20 +1512,20 @@ class Migration {
    *
    * @param tableName - name of the table to add the index for
    * @param columns - indexed columns
-   * @param args - index options, or an index name and then options
+   * @param args - index options
    */
   addIndex(tableName, columns, ...args) {
-    return addIndex(this, this.up, tableName, columns, args);
+    return addIndex(this, this.up, tableName, columns, ...args);
   }
   /**
    * Drop the schema, create it on rollback. See {@link addIndex}.
    *
    * @param tableName - name of the table to add the index for
    * @param columns - indexed columns
-   * @param args - index options, or an index name and then options
+   * @param args - index options
    */
   dropIndex(tableName, columns, ...args) {
-    return addIndex(this, !this.up, tableName, columns, args);
+    return addIndex(this, !this.up, tableName, columns, ...args);
   }
   /**
    * Rename index:
@@ -2250,7 +2250,7 @@ const addColumn = (migration, up, tableName, columnName, fn) => {
     [columnName]: t.add(fn(t))
   }));
 };
-const addIndex = (migration, up, tableName, columns, args) => {
+const addIndex = (migration, up, tableName, columns, ...args) => {
   return changeTable(migration, up, tableName, {}, (t) => ({
     ...t.add(t.index(columns, ...args))
   }));
@@ -4260,11 +4260,7 @@ const tableToAst = (ctx, data, table, action, domains) => {
 const indexesOrExcludesToAst = (tableName, tableData, key) => {
   return tableData[key].reduce((acc, item) => {
     if (item.columns.length > 1 || item.columns.some((it) => "expression" in it)) {
-      const { name, ...options } = makeIndexOrExcludeOptions(
-        tableName,
-        item,
-        key
-      );
+      const options = makeIndexOrExcludeOptions(tableName, item, key);
       acc.push({
         columns: item.columns.map((it, i) => ({
           with: "exclude" in item && item.exclude ? item.exclude[i] : void 0,
@@ -4276,8 +4272,7 @@ const indexesOrExcludesToAst = (tableName, tableData, key) => {
         options: {
           ...options,
           include: item.include?.map(orchidCore.toCamelCase)
-        },
-        name
+        }
       });
     }
     return acc;
@@ -4444,12 +4439,12 @@ const collectColumnIndexesOrExcludes = (dbColumn, column, tableName, tableData,
     ((_a = column.data)[key] ?? (_a[key] = [])).push({
       with: "exclude" in item && item.exclude ? item.exclude[0] : void 0,
       options: {
+        name,
         collate: columnOptions.collate,
         opclass: columnOptions.opclass,
         order: columnOptions.order,
         ...itemOptions
-      },
-      name
+      }
     });
   }
 };
@@ -4729,7 +4724,7 @@ const pushIndexOrExcludeKeys = (change, keys, schema, table, name, key) => {
     const getName = key === "indexes" ? getIndexName : getExcludeName;
     for (const x of items) {
       keys.push(
-        x.name ? `${schema}.${x.name}` : getName(table, [{ column: change.column?.data.name ?? name }])
+        x.options.name ? `${schema}.${x.options.name}` : getName(table, [{ column: change.column?.data.name ?? name }])
       );
     }
   }
@@ -4739,7 +4734,9 @@ const pushIndexesOrExcludesKeys = (keys, schema, table, data, key) => {
   if (arr) {
     const getName = key === "indexes" ? getIndexName : getExcludeName;
     for (const x of arr) {
-      keys.push(x.name ? `${schema}.${x.name}` : getName(table, x.columns));
+      keys.push(
+        x.options.name ? `${schema}.${x.options.name}` : getName(table, x.columns)
+      );
     }
   }
 };
@@ -5863,7 +5860,24 @@ const migrateFiles = async (db, files) => {
     }
   });
 };
+const makeMigrateAdapter = (config) => {
+  const conf = ensureMigrationsPath(ensureBasePathAndDbScript(config || {}));
+  return async (adapter, params) => {
+    await migrateAndClose({
+      adapter,
+      ...params,
+      config: {
+        ...conf,
+        columnTypes: conf.columnTypes || pqb.makeColumnTypes(pqb.defaultSchemaConfig),
+        migrationId: conf.migrationId || migrationConfigDefaults.migrationId,
+        migrationsTable: conf.migrationsTable || migrationConfigDefaults.migrationsTable,
+        import: conf.import || migrationConfigDefaults.import
+      }
+    });
+  };
+};
 
+exports.RakeDbError = RakeDbError;
 exports.astToMigration = astToMigration;
 exports.concatSchemaAndName = concatSchemaAndName;
 exports.createMigrationInterface = createMigrationInterface;
@@ -5877,16 +5891,20 @@ exports.getIndexName = getIndexName;
 exports.getSchemaAndTableFromName = getSchemaAndTableFromName;
 exports.instantiateDbColumn = instantiateDbColumn;
 exports.introspectDbSchema = introspectDbSchema;
+exports.makeChange = makeChange;
 exports.makeDomainsMap = makeDomainsMap;
 exports.makeFileVersion = makeFileVersion;
+exports.makeMigrateAdapter = makeMigrateAdapter;
 exports.makeStructureToAstCtx = makeStructureToAstCtx;
 exports.migrate = migrate;
 exports.migrateAndClose = migrateAndClose;
 exports.migrateFiles = migrateFiles;
 exports.migrationConfigDefaults = migrationConfigDefaults;
+exports.processRakeDbConfig = processRakeDbConfig;
 exports.promptSelect = promptSelect;
 exports.rakeDbCommands = rakeDbCommands;
 exports.rakeDbWithAdapters = rakeDbWithAdapters;
+exports.runCommand = runCommand;
 exports.saveMigratedVersion = saveMigratedVersion;
 exports.structureToAst = structureToAst;
 exports.tableToAst = tableToAst;