rake-db 2.23.16 → 2.23.18

package/dist/index.d.ts

@@ -62,6 +62,7 @@ declare namespace RakeDbAst {
         check?: ColumnDataCheckBase;
         foreignKeys?: TableData.ColumnReferences[];
         indexes?: TableData.ColumnIndex[];
+        excludes?: TableData.ColumnExclude[];
         identity?: TableData.Identity;
     }
     interface RenameType {
@@ -246,6 +247,7 @@ declare const tableChangeMethods: {
     };
     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;
     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;
@@ -1504,6 +1506,10 @@ declare const migrateOrRollback: (trx: TransactionAdapter, config: RakeDbConfig<
 declare const changeCache: Record<string, ChangeCallback<unknown>[] | undefined>;
 
 declare namespace DbStructure {
+    interface TableNameAndSchemaName {
+        schemaName: string;
+        tableName: string;
+    }
     interface Table {
         schemaName: string;
         name: string;
@@ -1531,9 +1537,7 @@ declare namespace DbStructure {
         argModes: ('i' | 'o')[];
         argNames?: string[];
     }
-    interface Column {
-        schemaName: string;
-        tableName: string;
+    interface Column extends TableNameAndSchemaName {
         name: string;
         typeSchema: string;
         type: string;
@@ -1559,9 +1563,7 @@ declare namespace DbStructure {
         extension?: string;
         typmod: number;
     }
-    interface Index {
-        schemaName: string;
-        tableName: string;
+    interface Index extends TableNameAndSchemaName {
         name: string;
         using: string;
         unique: boolean;
@@ -1584,11 +1586,12 @@ declare namespace DbStructure {
         language?: string;
         languageColumn?: string;
     }
+    interface Exclude extends Index {
+        exclude: string[];
+    }
     type ForeignKeyMatch = 'f' | 'p' | 's';
     type ForeignKeyAction = 'a' | 'r' | 'c' | 'n' | 'd';
-    interface Constraint {
-        schemaName: string;
-        tableName: string;
+    interface Constraint extends TableNameAndSchemaName {
         name: string;
         primaryKey?: string[];
         references?: References;
@@ -1607,9 +1610,7 @@ declare namespace DbStructure {
         columns?: string[];
         expression: string;
     }
-    interface Trigger {
-        schemaName: string;
-        tableName: string;
+    interface Trigger extends TableNameAndSchemaName {
         triggerSchema: string;
         name: string;
         events: string[];
@@ -1658,6 +1659,7 @@ interface IntrospectedStructure {
     tables: DbStructure.Table[];
     views: DbStructure.View[];
     indexes: DbStructure.Index[];
+    excludes: DbStructure.Exclude[];
     constraints: DbStructure.Constraint[];
     triggers: DbStructure.Trigger[];
     extensions: DbStructure.Extension[];
@@ -1680,6 +1682,7 @@ interface StructureToAstCtx {
 interface StructureToAstTableData {
     primaryKey?: TableData.PrimaryKey;
     indexes: DbStructure.Index[];
+    excludes: DbStructure.Exclude[];
     constraints: DbStructure.Constraint[];
 }
 declare const makeStructureToAstCtx: (config: AnyRakeDbConfig, currentSchema: string) => StructureToAstCtx;
@@ -1705,6 +1708,7 @@ declare const columnToSql: (name: string, item: ColumnType, values: unknown[], h
 declare const encodeColumnDefault: (def: unknown, values: unknown[], column?: ColumnTypeBase) => string | null;
 declare const identityToSql: (identity: TableData.Identity) => string;
 declare const addColumnIndex: (indexes: TableData.Index[], name: string, item: ColumnType) => void;
+declare const addColumnExclude: (excludes: TableData.Exclude[], name: string, item: ColumnType) => void;
 declare const addColumnComment: (comments: ColumnComment[], name: string, item: ColumnType) => void;
 declare const getForeignKeyTable: (fnOrTable: (() => ForeignKeyTable) | string) => [string | undefined, string];
 declare const getConstraintName: (table: string, constraint: {
@@ -1719,15 +1723,23 @@ declare const constraintToSql: ({ name }: {
     name: string;
 }, up: boolean, constraint: TableData.Constraint, values: unknown[], snakeCase: boolean | undefined) => string;
 declare const referencesToSql: (references: TableData.References, snakeCase: boolean | undefined) => string;
-declare const getIndexName: (table: string, columns: ({
-    column?: string;
-} | {
-    expression: string;
-})[]) => string;
+interface GetIndexOrExcludeName {
+    (table: string, columns: ({
+        column?: string;
+    } | {
+        expression: string;
+    })[]): string;
+}
+declare const getIndexName: GetIndexOrExcludeName;
+declare const getExcludeName: GetIndexOrExcludeName;
 declare const indexesToQuery: (up: boolean, { schema, name: tableName }: {
     schema?: string;
     name: string;
 }, indexes: TableData.Index[], snakeCase: boolean | undefined, language?: string) => SingleSql[];
+declare const excludesToQuery: (up: boolean, { schema, name: tableName }: {
+    schema?: string;
+    name: string;
+}, excludes: TableData.Exclude[], snakeCase: boolean | undefined) => SingleSql[];
 declare const commentsToQuery: (schemaTable: {
     schema?: string;
     name: string;
@@ -1819,4 +1831,4 @@ declare const promptText: ({ message, default: def, password, min, }: {
     min?: number;
 }) => Promise<string>;
 
-export { type AnyRakeDbConfig, type ChangeCallback, type ChangeTableCallback, type ChangeTableOptions, type ColumnComment, type ColumnsShapeCallback, type CommandFn, type DbMigration, DbStructure, type DbStructureDomainsMap, type DropMode, type InputRakeDbConfig, type InputRakeDbConfigBase, type IntrospectedStructure, Migration, type MigrationAdapter, type MigrationColumnTypes, type ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, type RakeDbAppliedVersions, RakeDbAst, type RakeDbBaseTable, type RakeDbChangeFn, type RakeDbConfig, type RakeDbCtx, type RakeDbFn, type RakeDbFnReturns, type RakeDbLazyFn, type RakeDbMigrationId, type RakeDbRenameMigrations, type RakeDbRenameMigrationsInput, type RakeDbRenameMigrationsMap, type RakeDbResult, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, type TableOptions, addColumnComment, addColumnIndex, addOrDropEnumValues, astToMigration, changeCache, changeEnumValues, clearChanges, colors, columnToSql, columnTypeToSql, commentsToQuery, concatSchemaAndName, constraintToSql, createDb, createMigrationInterface, dbColumnToAst, deleteMigratedVersion, dropDb, encodeColumnDefault, exhaustive, generateTimeStamp, getColumnName, getConstraintName, getCurrentChanges, getDatabaseAndUserFromOptions, getDbStructureTableData, getDbTableColumnsChecks, getFirstWordAndRest, getForeignKeyTable, getIndexName, getMigratedVersionsMap, getSchemaAndTableFromName, getTextAfterFrom, getTextAfterTo, identityToSql, indexesToQuery, instantiateDbColumn, interpolateSqlValues, introspectDbSchema, joinColumns, joinWords, makeDbStructureColumnsShape, makeDomainsMap, makeFileVersion, makePopulateEnumQuery, makeStructureToAstCtx, migrate, migrateOrRollback, migrationConfigDefaults, newMigration, pluralize, primaryKeyToSql, processRakeDbConfig, promptConfirm, promptSelect, promptText, pushChange, queryLock, quoteCustomType, quoteNameFromString, quoteSchemaTable, quoteTable, quoteWithSchema, rakeDb, rakeDbAliases, rakeDbCommands, redo, referencesToSql, renameType, resetDb, rollback, saveMigratedVersion, structureToAst, tableToAst, transaction, versionToString, writeMigrationFile };
+export { type AnyRakeDbConfig, type ChangeCallback, type ChangeTableCallback, type ChangeTableOptions, type ColumnComment, type ColumnsShapeCallback, type CommandFn, type DbMigration, DbStructure, type DbStructureDomainsMap, type DropMode, type GetIndexOrExcludeName, type InputRakeDbConfig, type InputRakeDbConfigBase, type IntrospectedStructure, Migration, type MigrationAdapter, type MigrationColumnTypes, type ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, type RakeDbAppliedVersions, RakeDbAst, type RakeDbBaseTable, type RakeDbChangeFn, type RakeDbConfig, type RakeDbCtx, type RakeDbFn, type RakeDbFnReturns, type RakeDbLazyFn, type RakeDbMigrationId, type RakeDbRenameMigrations, type RakeDbRenameMigrationsInput, type RakeDbRenameMigrationsMap, type RakeDbResult, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, type TableOptions, addColumnComment, addColumnExclude, addColumnIndex, addOrDropEnumValues, astToMigration, changeCache, changeEnumValues, clearChanges, colors, columnToSql, columnTypeToSql, commentsToQuery, concatSchemaAndName, constraintToSql, createDb, createMigrationInterface, dbColumnToAst, deleteMigratedVersion, dropDb, encodeColumnDefault, excludesToQuery, exhaustive, generateTimeStamp, getColumnName, getConstraintName, getCurrentChanges, getDatabaseAndUserFromOptions, getDbStructureTableData, getDbTableColumnsChecks, getExcludeName, getFirstWordAndRest, getForeignKeyTable, getIndexName, getMigratedVersionsMap, getSchemaAndTableFromName, getTextAfterFrom, getTextAfterTo, identityToSql, indexesToQuery, instantiateDbColumn, interpolateSqlValues, introspectDbSchema, joinColumns, joinWords, makeDbStructureColumnsShape, makeDomainsMap, makeFileVersion, makePopulateEnumQuery, makeStructureToAstCtx, migrate, migrateOrRollback, migrationConfigDefaults, newMigration, pluralize, primaryKeyToSql, processRakeDbConfig, promptConfirm, promptSelect, promptText, pushChange, queryLock, quoteCustomType, quoteNameFromString, quoteSchemaTable, quoteTable, quoteWithSchema, rakeDb, rakeDbAliases, rakeDbCommands, redo, referencesToSql, renameType, resetDb, rollback, saveMigratedVersion, structureToAst, tableToAst, transaction, versionToString, writeMigrationFile };