rake-db 2.29.10 → 2.30.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as pqb from 'pqb';
-import { TableData, ColumnsShape, NoPrimaryKeyOption, MaybeArray, Column, RawSqlBase, RecordString, EnumColumn, EmptyObject, AdapterBase, DbResult, DefaultColumnTypes, DefaultSchemaConfig, QueryLogObject, TableDataFn, TableDataItem, DbDomainArg, ColumnSchemaConfig, raw, Db, MaybePromise, QueryLogOptions, QuerySchema, QueryLogger, SearchWeight, ColumnsByType, DbStructureDomainsMap } from 'pqb';
+import { TableData, ColumnsShape, NoPrimaryKeyOption, MaybeArray, Column, RawSqlBase, RecordString, EnumColumn, EmptyObject, AdapterBase, DbResult, DefaultColumnTypes, DefaultSchemaConfig, QueryLogObject, TableDataFn, TableDataItem, DbDomainArg, ColumnSchemaConfig, raw, Db, QuerySchema, MaybePromise, QueryLogOptions, QueryLogger, SearchWeight, ColumnsByType, DbStructureDomainsMap } from 'pqb';
 
 type RakeDbAst = RakeDbAst.Table | RakeDbAst.ChangeTable | RakeDbAst.RenameType | RakeDbAst.Schema | RakeDbAst.RenameSchema | RakeDbAst.Extension | RakeDbAst.Enum | RakeDbAst.EnumValues | RakeDbAst.RenameEnumValues | RakeDbAst.ChangeEnumValues | RakeDbAst.Domain | RakeDbAst.Collation | RakeDbAst.Constraint | RakeDbAst.RenameTableItem | RakeDbAst.View;
 declare namespace RakeDbAst {
@@ -291,10 +291,10 @@ type ChangeTableOptions = {
     comment?: string | [string, string] | null;
 };
 type ChangeTableCallback<CT> = (t: TableChanger<CT>) => TableChangeData;
-type SilentQueries = {
+interface SilentQueries extends AdapterBase {
     silentQuery: AdapterBase['query'];
     silentArrays: AdapterBase['arrays'];
-};
+}
 type DbMigration<CT> = DbResult<CT> & Migration<CT> & {
     adapter: SilentQueries;
 };
@@ -1224,7 +1224,7 @@ interface CreateTableResult<Table extends string, Shape extends ColumnsShape> {
 interface RakeDbCtx {
     migrationsPromise?: Promise<MigrationsSet>;
 }
-declare const getSchemaAndTableFromName: (config: Pick<RakeDbConfig, 'schema'>, name: string) => [string | undefined, string];
+declare const getSchemaAndTableFromName: (schema: QuerySchema | undefined, name: string) => [string | undefined, string];
 declare const concatSchemaAndName: ({ schema, name, }: {
     schema?: string;
     name: string;
@@ -1248,6 +1248,7 @@ interface MigrationsSet {
     migrations: MigrationItem[];
 }
 
+type SearchPath = (() => string) | string;
 interface RakeDbCliConfigInputBase<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>> extends QueryLogOptions {
     columnTypes?: CT | ((t: DefaultColumnTypes<DefaultSchemaConfig>) => CT);
     baseTable?: RakeDbBaseTable<CT>;
@@ -1263,6 +1264,12 @@ interface RakeDbCliConfigInputBase<SchemaConfig extends ColumnSchemaConfig, CT =
         [commandName: string]: RakeDbCommandFn | RakeDbCommand;
     };
     noPrimaryKey?: NoPrimaryKeyOption;
+    transactionSearchPath?: SearchPath;
+    /**
+     * Throw if a migration doesn't have a default export.
+     * This is needed when in your setup you're importing migration files first and execute them later,
+     * in that case you should export changes in migrations.
+     */
     forceDefaultExports?: boolean;
     /**
      * Is called once per db before migrating or rolling back a set of migrations.
@@ -1347,11 +1354,6 @@ interface RakeDbConfig<ColumnTypes = unknown> extends QueryLogOptions {
      */
     __rakeDbConfig: true;
     migrationsTable: string;
-    /**
-     * by default, all the migrated tables and the special table for tracking migrations are created in `public`.
-     * set this `schema` setting to use create everything in this schema instead.
-     */
-    schema?: QuerySchema;
     recurrentPath?: string;
     columnTypes: ColumnTypes;
     beforeChange?: ChangeCallback$1;
@@ -1361,6 +1363,7 @@ interface RakeDbConfig<ColumnTypes = unknown> extends QueryLogOptions {
     beforeRollback?: MigrationCallback;
     afterRollback?: MigrationCallback;
     migrationId: RakeDbMigrationId;
+    transactionSearchPath?: SearchPath;
     forceDefaultExports?: boolean;
     afterChangeCommit?: ChangeCommitCallback;
     basePath: string;
@@ -1496,8 +1499,7 @@ interface GetIndexOrExcludeName {
 }
 declare const getIndexName: GetIndexOrExcludeName;
 declare const getExcludeName: GetIndexOrExcludeName;
-declare const getMigrationsSchemaAndTable: (config: {
-    schema?: QuerySchema;
+declare const getMigrationsSchemaAndTable: (adapter: AdapterBase, config: {
     migrationsTable: string;
 }) => {
     schema?: string;
@@ -1518,7 +1520,6 @@ type DbParam = OrmParam | AdapterBase;
 
 declare const saveMigratedVersion: (db: SilentQueries, version: string, name: string, config: Pick<RakeDbConfig, 'migrationsTable'>) => Promise<void>;
 declare const createMigrationsSchemaAndTable: (db: DbParam, config: {
-    schema?: QuerySchema;
     migrationsTable: string;
     logger?: QueryLogger;
 }) => Promise<void>;
@@ -1736,7 +1737,7 @@ interface StructureToAstTableData {
     constraints: DbStructure.Constraint[];
 }
 declare const makeStructureToAstCtx: (config: Pick<RakeDbConfig, 'snakeCase' | 'schemaConfig'>, currentSchema: string) => StructureToAstCtx;
-declare const structureToAst: (ctx: StructureToAstCtx, adapter: AdapterBase, config: Pick<RakeDbConfig, 'schema' | 'migrationsTable'>) => Promise<RakeDbAst[]>;
+declare const structureToAst: (ctx: StructureToAstCtx, adapter: AdapterBase, config: Pick<RakeDbConfig, 'migrationsTable'>) => Promise<RakeDbAst[]>;
 declare const makeDomainsMap: (ctx: StructureToAstCtx, data: IntrospectedStructure) => DbStructureDomainsMap;
 declare const instantiateDbColumn: (ctx: StructureToAstCtx, data: IntrospectedStructure, domains: DbStructureDomainsMap, dbColumn: DbStructure.Column) => Column<pqb.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any>;
 declare const tableToAst: (ctx: StructureToAstCtx, data: IntrospectedStructure, table: DbStructure.Table, action: 'create' | 'drop', domains: DbStructureDomainsMap) => RakeDbAst.Table;