rake-db 2.29.10 → 2.30.1

package/dist/index.d.ts

@@ -1,7 +1,190 @@
 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 { SearchWeight, RecordOptionalString, AdapterBase, TableData, ColumnsShape, NoPrimaryKeyOption, MaybeArray, Column, RawSqlBase, RecordString, EnumColumn, EmptyObject, DbResult, DefaultColumnTypes, DefaultSchemaConfig, QueryLogObject, TableDataFn, TableDataItem, DbDomainArg, ColumnSchemaConfig, raw, Db, QuerySchema, MaybePromise, QueryLogOptions, QueryLogger, 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 DbStructure {
+    interface TableNameAndSchemaName {
+        schemaName: string;
+        tableName: string;
+    }
+    interface Table {
+        schemaName: string;
+        name: string;
+        comment?: string;
+        columns: Column[];
+    }
+    interface View {
+        schemaName: string;
+        name: string;
+        deps: RakeDbAst.View['deps'];
+        isRecursive: boolean;
+        with?: string[];
+        columns: Column[];
+        sql: string;
+    }
+    interface Procedure {
+        schemaName: string;
+        name: string;
+        returnSet: boolean;
+        returnType: string;
+        kind: string;
+        isTrigger: boolean;
+        types: string[];
+        argTypes: string[];
+        argModes: ('i' | 'o')[];
+        argNames?: string[];
+    }
+    interface Column extends TableNameAndSchemaName {
+        name: string;
+        typeSchema: string;
+        type: string;
+        arrayDims: number;
+        maxChars?: number;
+        numericPrecision?: number;
+        numericScale?: number;
+        dateTimePrecision?: number;
+        default?: string;
+        isNullable: boolean;
+        collate?: string;
+        compression?: 'pglz' | 'lz4';
+        comment?: string;
+        identity?: {
+            always: boolean;
+            start: number;
+            increment: number;
+            min?: number;
+            max?: number;
+            cache: number;
+            cycle: boolean;
+        };
+        extension?: string;
+        typmod: number;
+    }
+    interface Index extends TableNameAndSchemaName {
+        name: string;
+        using: string;
+        unique: boolean;
+        columns: (({
+            column: string;
+        } | {
+            expression: string;
+        }) & {
+            collate?: string;
+            opclass?: string;
+            order?: string;
+            weight?: SearchWeight;
+        })[];
+        include?: string[];
+        nullsNotDistinct?: boolean;
+        with?: string;
+        tablespace?: string;
+        where?: string;
+        tsVector?: boolean;
+        language?: string;
+        languageColumn?: string;
+    }
+    interface Exclude extends Index {
+        exclude: string[];
+    }
+    type ForeignKeyMatch = 'f' | 'p' | 's';
+    type ForeignKeyAction = 'a' | 'r' | 'c' | 'n' | 'd';
+    interface Constraint extends TableNameAndSchemaName {
+        name: string;
+        primaryKey?: string[];
+        references?: References;
+        check?: Check;
+    }
+    interface References {
+        foreignSchema: string;
+        foreignTable: string;
+        columns: string[];
+        foreignColumns: string[];
+        match: ForeignKeyMatch;
+        onUpdate: ForeignKeyAction;
+        onDelete: ForeignKeyAction;
+    }
+    interface Check {
+        columns?: string[];
+        expression: string;
+    }
+    interface Trigger extends TableNameAndSchemaName {
+        triggerSchema: string;
+        name: string;
+        events: string[];
+        activation: string;
+        condition?: string;
+        definition: string;
+    }
+    interface Extension {
+        schemaName: string;
+        name: string;
+        version?: string;
+    }
+    interface Enum {
+        schemaName: string;
+        name: string;
+        values: [string, ...string[]];
+    }
+    interface Domain {
+        schemaName: string;
+        name: string;
+        type: string;
+        typeSchema: string;
+        arrayDims: number;
+        isNullable: boolean;
+        maxChars?: number;
+        numericPrecision?: number;
+        numericScale?: number;
+        dateTimePrecision?: number;
+        collate?: string;
+        default?: string;
+        checks?: string[];
+    }
+    interface Collation {
+        schemaName: string;
+        name: string;
+        provider: string;
+        deterministic: boolean;
+        lcCollate?: string;
+        lcCType?: string;
+        locale?: string;
+        version?: string;
+    }
+    interface Role {
+        name: string;
+        super: boolean;
+        inherit: boolean;
+        createRole: boolean;
+        createDb: boolean;
+        canLogin: boolean;
+        replication: boolean;
+        connLimit: number;
+        validUntil?: Date;
+        bypassRls: boolean;
+        config?: RecordOptionalString;
+    }
+}
+interface IntrospectedStructure {
+    schemas: string[];
+    tables: DbStructure.Table[];
+    views: DbStructure.View[];
+    indexes: DbStructure.Index[];
+    excludes: DbStructure.Exclude[];
+    constraints: DbStructure.Constraint[];
+    triggers: DbStructure.Trigger[];
+    extensions: DbStructure.Extension[];
+    enums: DbStructure.Enum[];
+    domains: DbStructure.Domain[];
+    collations: DbStructure.Collation[];
+    roles?: DbStructure.Role[];
+}
+interface IntrospectDbStructureParams {
+    roles?: {
+        whereSql?: string;
+    };
+}
+declare function introspectDbSchema(db: AdapterBase, params?: IntrospectDbStructureParams): Promise<IntrospectedStructure>;
+
+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 | RakeDbAst.Role | RakeDbAst.ChangeRole;
 declare namespace RakeDbAst {
     interface Table extends TableData {
         type: 'table';
@@ -192,6 +375,16 @@ declare namespace RakeDbAst {
             securityInvoker?: boolean;
         };
     }
+    interface Role extends DbStructure.Role {
+        type: 'role';
+        action: 'create' | 'drop';
+    }
+    interface ChangeRole {
+        type: 'changeRole';
+        name: string;
+        from: Partial<DbStructure.Role>;
+        to: Partial<DbStructure.Role>;
+    }
 }
 
 declare function add(item: Column, options?: {
@@ -291,10 +484,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;
 };
@@ -1210,6 +1403,12 @@ declare class Migration<CT = unknown> {
      * @param constraintName - name of the constraint
      */
     constraintExists(constraintName: string): Promise<boolean>;
+    createRole(name: string, params: Partial<DbStructure.Role>): Promise<void>;
+    dropRole(name: string, params?: Partial<DbStructure.Role>): Promise<void>;
+    changeRole(name: string, params: {
+        from?: Partial<DbStructure.Role>;
+        to: Partial<DbStructure.Role>;
+    }): Promise<void>;
 }
 interface AddEnumValueOptions {
     ifNotExists?: boolean;
@@ -1224,7 +1423,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 +1447,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 +1463,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 +1553,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 +1562,7 @@ interface RakeDbConfig<ColumnTypes = unknown> extends QueryLogOptions {
     beforeRollback?: MigrationCallback;
     afterRollback?: MigrationCallback;
     migrationId: RakeDbMigrationId;
+    transactionSearchPath?: SearchPath;
     forceDefaultExports?: boolean;
     afterChangeCommit?: ChangeCommitCallback;
     basePath: string;
@@ -1496,8 +1698,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 +1719,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>;
@@ -1541,7 +1741,8 @@ interface MigrateFn {
  */
 declare const migrate: MigrateFn;
 declare const migrateAndClose: MigrateFn;
-declare const runMigration: (db: DbParam, migration: () => MaybePromise<unknown>) => Promise<void>;
+declare function runMigration(db: DbParam, migration: () => MaybePromise<unknown>): Promise<void>;
+declare function runMigration(db: DbParam, config: Pick<RakeDbConfig, 'transactionSearchPath'>, migration: () => MaybePromise<unknown>): Promise<void>;
 /**
  * Will roll back one latest applied migration,
  * will apply `change` functions bottom-to-top.
@@ -1556,170 +1757,6 @@ declare const rollback: MigrateFn;
  */
 declare const redo: MigrateFn;
 
-declare namespace DbStructure {
-    interface TableNameAndSchemaName {
-        schemaName: string;
-        tableName: string;
-    }
-    interface Table {
-        schemaName: string;
-        name: string;
-        comment?: string;
-        columns: Column[];
-    }
-    interface View {
-        schemaName: string;
-        name: string;
-        deps: RakeDbAst.View['deps'];
-        isRecursive: boolean;
-        with?: string[];
-        columns: Column[];
-        sql: string;
-    }
-    interface Procedure {
-        schemaName: string;
-        name: string;
-        returnSet: boolean;
-        returnType: string;
-        kind: string;
-        isTrigger: boolean;
-        types: string[];
-        argTypes: string[];
-        argModes: ('i' | 'o')[];
-        argNames?: string[];
-    }
-    interface Column extends TableNameAndSchemaName {
-        name: string;
-        typeSchema: string;
-        type: string;
-        arrayDims: number;
-        maxChars?: number;
-        numericPrecision?: number;
-        numericScale?: number;
-        dateTimePrecision?: number;
-        default?: string;
-        isNullable: boolean;
-        collate?: string;
-        compression?: 'pglz' | 'lz4';
-        comment?: string;
-        identity?: {
-            always: boolean;
-            start: number;
-            increment: number;
-            min?: number;
-            max?: number;
-            cache: number;
-            cycle: boolean;
-        };
-        extension?: string;
-        typmod: number;
-    }
-    interface Index extends TableNameAndSchemaName {
-        name: string;
-        using: string;
-        unique: boolean;
-        columns: (({
-            column: string;
-        } | {
-            expression: string;
-        }) & {
-            collate?: string;
-            opclass?: string;
-            order?: string;
-            weight?: SearchWeight;
-        })[];
-        include?: string[];
-        nullsNotDistinct?: boolean;
-        with?: string;
-        tablespace?: string;
-        where?: string;
-        tsVector?: boolean;
-        language?: string;
-        languageColumn?: string;
-    }
-    interface Exclude extends Index {
-        exclude: string[];
-    }
-    type ForeignKeyMatch = 'f' | 'p' | 's';
-    type ForeignKeyAction = 'a' | 'r' | 'c' | 'n' | 'd';
-    interface Constraint extends TableNameAndSchemaName {
-        name: string;
-        primaryKey?: string[];
-        references?: References;
-        check?: Check;
-    }
-    interface References {
-        foreignSchema: string;
-        foreignTable: string;
-        columns: string[];
-        foreignColumns: string[];
-        match: ForeignKeyMatch;
-        onUpdate: ForeignKeyAction;
-        onDelete: ForeignKeyAction;
-    }
-    interface Check {
-        columns?: string[];
-        expression: string;
-    }
-    interface Trigger extends TableNameAndSchemaName {
-        triggerSchema: string;
-        name: string;
-        events: string[];
-        activation: string;
-        condition?: string;
-        definition: string;
-    }
-    interface Extension {
-        schemaName: string;
-        name: string;
-        version?: string;
-    }
-    interface Enum {
-        schemaName: string;
-        name: string;
-        values: [string, ...string[]];
-    }
-    interface Domain {
-        schemaName: string;
-        name: string;
-        type: string;
-        typeSchema: string;
-        arrayDims: number;
-        isNullable: boolean;
-        maxChars?: number;
-        numericPrecision?: number;
-        numericScale?: number;
-        dateTimePrecision?: number;
-        collate?: string;
-        default?: string;
-        checks?: string[];
-    }
-    interface Collation {
-        schemaName: string;
-        name: string;
-        provider: string;
-        deterministic: boolean;
-        lcCollate?: string;
-        lcCType?: string;
-        locale?: string;
-        version?: string;
-    }
-}
-interface IntrospectedStructure {
-    schemas: string[];
-    tables: DbStructure.Table[];
-    views: DbStructure.View[];
-    indexes: DbStructure.Index[];
-    excludes: DbStructure.Exclude[];
-    constraints: DbStructure.Constraint[];
-    triggers: DbStructure.Trigger[];
-    extensions: DbStructure.Extension[];
-    enums: DbStructure.Enum[];
-    domains: DbStructure.Domain[];
-    collations: DbStructure.Collation[];
-}
-declare function introspectDbSchema(db: AdapterBase): Promise<IntrospectedStructure>;
-
 declare const astToMigration: (currentSchema: string, config: RakeDbConfig, asts: RakeDbAst[]) => string | undefined;
 
 interface StructureToAstCtx {
@@ -1734,9 +1771,10 @@ interface StructureToAstTableData {
     indexes: DbStructure.Index[];
     excludes: DbStructure.Exclude[];
     constraints: DbStructure.Constraint[];
+    roles?: DbStructure.Role[];
 }
 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;