rake-db 2.20.3 → 2.20.5

package/dist/index.d.ts

@@ -931,7 +931,7 @@ declare class Migration<CT> {
      *
      * change(async (db) => {
      *   await db.createDomain('domainName', (t) =>
-     *     t.integer().check(db.sql`value = 42`),
+     *     t.integer().check(t.sql`value = 42`),
      *   );
      *
      *   // use `schemaName.domainName` format to specify a schema
@@ -941,7 +941,7 @@ declare class Migration<CT> {
      *       .nullable()
      *       .collate('C')
      *       .default('default text')
-     *       .check(db.sql`length(value) > 10`),
+     *       .check(t.sql`length(value) > 10`),
      *   );
      * });
      * ```
@@ -1050,7 +1050,7 @@ declare class Migration<CT> {
     /**
      * Create and drop database views.
      *
-     * Provide SQL as a string or via `db.sql` that can accept variables.
+     * Provide SQL as a string or via `t.sql` that can accept variables.
      *
      * ```ts
      * import { change } from '../dbScript';
@@ -1065,11 +1065,11 @@ declare class Migration<CT> {
      *   `,
      *   );
      *
-     *   // view can accept db.sql with variables in such way:
+     *   // view can accept t.sql with variables in such way:
      *   const value = 'some value';
      *   await db.createView(
      *     'viewWithVariables',
-     *     db.sql`
+     *     t.sql`
      *       SELECT * FROM a WHERE key = ${value}
      *     `,
      *   );
@@ -1277,7 +1277,7 @@ interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColu
     beforeRollback?: MigrationCallback;
     afterRollback?: MigrationCallback;
 }
-interface InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> extends QueryLogOptions {
+interface InputRakeDbConfigBase<SchemaConfig extends ColumnSchemaConfig, CT> extends QueryLogOptions {
     columnTypes?: CT | ((t: DefaultColumnTypes<DefaultSchemaConfig>) => CT);
     baseTable?: RakeDbBaseTable<CT>;
     schemaConfig?: SchemaConfig;
@@ -1285,7 +1285,6 @@ interface InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> extends
     dbScript?: string;
     migrationsPath?: string;
     migrationId?: RakeDbMigrationId;
-    migrations?: ModuleExportsRecord;
     recurrentPath?: string;
     migrationsTable?: string;
     snakeCase?: boolean;
@@ -1293,10 +1292,6 @@ interface InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> extends
     commands?: Record<string, (options: AdapterOptions[], config: RakeDbConfig<SchemaConfig, CT extends undefined ? DefaultColumnTypes<DefaultSchemaConfig> : CT>, args: string[]) => void | Promise<void>>;
     noPrimaryKey?: NoPrimaryKeyOption;
     forceDefaultExports?: boolean;
-    /**
-     * It may look odd, but it's required for `tsx` and other bundlers to have such `import` config specified explicitly.
-     */
-    import(path: string): Promise<unknown>;
     /**
      * Is called once per db before migrating or rolling back a set of migrations.
      *
@@ -1355,6 +1350,21 @@ interface InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> extends
      */
     afterRollback?: MigrationCallback;
 }
+type InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> = InputRakeDbConfigBase<SchemaConfig, CT> & ({
+    /**
+     * It may look odd, but it's required for `tsx` and other bundlers to have such `import` config specified explicitly.
+     */
+    import(path: string): Promise<unknown>;
+} | {
+    /**
+     * To specify array of migrations explicitly, without loading them from files.
+     */
+    migrations: ModuleExportsRecord;
+    /**
+     * It may look odd, but it's required for `tsx` and other bundlers to have such `import` config specified explicitly.
+     */
+    import?(path: string): Promise<unknown>;
+});
 type ChangeCallback$1 = (arg: {
     db: Db;
     up: boolean;
@@ -1395,6 +1405,7 @@ declare const migrationConfigDefaults: {
     commands: {};
     log: true;
     logger: Console;
+    import(): never;
 };
 declare const processRakeDbConfig: <SchemaConfig extends ColumnSchemaConfig<orchid_core.ColumnTypeBase<orchid_core.ColumnTypeSchemaArg, unknown, any, orchid_core.CoreBaseOperators, unknown, unknown, any, unknown, any, orchid_core.ColumnDataBase>>, CT>(config: InputRakeDbConfig<SchemaConfig, CT>) => RakeDbConfig<SchemaConfig, CT>;
 declare const getDatabaseAndUserFromOptions: (options: AdapterOptions) => {
@@ -1766,4 +1777,4 @@ declare const promptText: ({ message, default: def, password, min, }: {
     min?: number;
 }) => Promise<string>;
 
-export { AnyRakeDbConfig, ChangeCallback, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, CommandFn, DbMigration, DbStructure, DbStructureDomainsMap, DropMode, InputRakeDbConfig, IntrospectedStructure, Migration, MigrationAdapter, MigrationColumnTypes, ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAppliedVersions, RakeDbAst, RakeDbBaseTable, RakeDbChangeFn, RakeDbConfig, RakeDbCtx, RakeDbFn, RakeDbFnReturns, RakeDbLazyFn, RakeDbMigrationId, RakeDbResult, SilentQueries, StructureToAstCtx, StructureToAstTableData, 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, introspectDbSchema, joinColumns, joinWords, makeDbStructureColumnsShape, makeDomainsMap, makeFileVersion, makePopulateEnumQuery, makeStructureToAstCtx, migrate, migrateOrRollback, migrationConfigDefaults, newMigration, pluralize, primaryKeyToSql, processRakeDbConfig, promptConfirm, promptSelect, promptText, pushChange, queryLock, quoteNameFromString, quoteSchemaTable, quoteTable, quoteWithSchema, rakeDb, rakeDbAliases, rakeDbCommands, redo, referencesToSql, renameType, resetDb, rollback, saveMigratedVersion, structureToAst, tableToAst, transaction, versionToString, writeMigrationFile };
+export { AnyRakeDbConfig, ChangeCallback, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, CommandFn, DbMigration, DbStructure, DbStructureDomainsMap, DropMode, InputRakeDbConfig, InputRakeDbConfigBase, IntrospectedStructure, Migration, MigrationAdapter, MigrationColumnTypes, ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAppliedVersions, RakeDbAst, RakeDbBaseTable, RakeDbChangeFn, RakeDbConfig, RakeDbCtx, RakeDbFn, RakeDbFnReturns, RakeDbLazyFn, RakeDbMigrationId, RakeDbResult, SilentQueries, StructureToAstCtx, StructureToAstTableData, 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, introspectDbSchema, joinColumns, joinWords, makeDbStructureColumnsShape, makeDomainsMap, makeFileVersion, makePopulateEnumQuery, makeStructureToAstCtx, migrate, migrateOrRollback, migrationConfigDefaults, newMigration, pluralize, primaryKeyToSql, processRakeDbConfig, promptConfirm, promptSelect, promptText, pushChange, queryLock, quoteNameFromString, quoteSchemaTable, quoteTable, quoteWithSchema, rakeDb, rakeDbAliases, rakeDbCommands, redo, referencesToSql, renameType, resetDb, rollback, saveMigratedVersion, structureToAst, tableToAst, transaction, versionToString, writeMigrationFile };

package/dist/index.js

@@ -1919,7 +1919,7 @@ class Migration {
    *
    * change(async (db) => {
    *   await db.createDomain('domainName', (t) =>
-   *     t.integer().check(db.sql`value = 42`),
+   *     t.integer().check(t.sql`value = 42`),
    *   );
    *
    *   // use `schemaName.domainName` format to specify a schema
@@ -1929,7 +1929,7 @@ class Migration {
    *       .nullable()
    *       .collate('C')
    *       .default('default text')
-   *       .check(db.sql`length(value) > 10`),
+   *       .check(t.sql`length(value) > 10`),
    *   );
    * });
    * ```
@@ -3090,7 +3090,10 @@ const migrationConfigDefaults = {
   snakeCase: false,
   commands: {},
   log: true,
-  logger: console
+  logger: console,
+  import() {
+    throw new Error("Please define the `import` setting in `rakeDb` config");
+  }
 };
 const processRakeDbConfig = (config) => {
   var _a, _b;