kysely 0.14.1 → 0.15.0

package/dist/cjs/query-builder/on-conflict-builder.js

@@ -163,7 +163,7 @@ class OnConflictBuilder {
      * ```ts
      * await db
      *   .insertInto('person')
-     *   .values({ id: db.generated, first_name, pic })
+     *   .values({ first_name, pic })
      *   .onConflict((oc) => oc
      *     .column('pic')
      *     .doNothing()
@@ -194,7 +194,7 @@ class OnConflictBuilder {
      * ```ts
      * await db
      *   .insertInto('person')
-     *   .values({ id: db.generated, first_name, pic })
+     *   .values({ first_name, pic })
      *   .onConflict((oc) => oc
      *     .column('pic')
      *     .doUpdateSet({ first_name })

package/dist/cjs/query-builder/returning-interface.d.ts

@@ -21,7 +21,6 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      * const { id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -35,7 +34,6 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      * const { id, first_name } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -51,7 +49,6 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      * const { id, full_name, first_pet_id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })

package/dist/cjs/query-builder/update-query-builder.d.ts

@@ -626,7 +626,6 @@ export declare class UpdateQueryBuilder<DB, TB extends keyof DB, O> implements W
      * const { id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -640,7 +639,6 @@ export declare class UpdateQueryBuilder<DB, TB extends keyof DB, O> implements W
      * const { id, first_name } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -656,7 +654,6 @@ export declare class UpdateQueryBuilder<DB, TB extends keyof DB, O> implements W
      * const { id, full_name, first_pet_id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })

package/dist/cjs/query-creator.d.ts

@@ -137,7 +137,6 @@ export declare class QueryCreator<DB> {
      * const result = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -152,7 +151,6 @@ export declare class QueryCreator<DB> {
      * const { id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })

package/dist/cjs/query-creator.js

@@ -46,7 +46,6 @@ class QueryCreator {
      * const result = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -61,7 +60,6 @@ class QueryCreator {
      * const { id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })

package/dist/cjs/util/column-type.d.ts

@@ -0,0 +1,165 @@
+/**
+ * This type can be used to specify a different type for
+ * select, insert and update operations.
+ *
+ * Also see the {@link Generated} type.
+ *
+ * ### Examples
+ *
+ * The next example defines a number column that is optional
+ * in inserts and updates. All columns are always optional
+ * in updates so therefore we don't need to specify `undefined`
+ * for the update type. The type below is useful for all kinds of
+ * database generated columns like identifiers. The `Generated`
+ * type is actually just a shortcut for the type in this example:
+ *
+ * ```ts
+ * ColumnType<number, number | undefined, number>
+ * ```
+ *
+ * The above example makes the column optional in inserts
+ * and updates, but you can still choose to provide the
+ * column. If you want to prevent insertion/update you
+ * can se the type as `never`:
+ *
+ * ```ts
+ * ColumnType<number, never, never>
+ * ```
+ *
+ * Here's one more example where the type is different
+ * for each different operation:
+ *
+ * ```ts
+ * ColumnType<Date, string, never>
+ * ```
+ */
+export declare type ColumnType<SelectType, InsertType = SelectType, UpdateType = SelectType> = {
+    readonly __select__: SelectType;
+    readonly __insert__: InsertType;
+    readonly __update__: UpdateType;
+};
+/**
+ * A shortcut for defining database-generated columns. The type
+ * is the same for all selects, inserts and updates but the
+ * column is optional for inserts and updates.
+ *
+ * This is implemented using {@link ColumnType} like this:
+ *
+ * ```ts
+ * type Generated<S> = ColumnType<S, S | undefined, S>
+ * ```
+ */
+export declare type Generated<S> = ColumnType<S, S | undefined, S>;
+/**
+ * Evaluates to `K` if `T` can be `null` or `undefined`.
+ */
+declare type IfNullable<T, K> = undefined extends T ? K : null extends T ? K : never;
+/**
+ * Evaluates to `K` if `T` can't be `null` or `undefined`.
+ */
+declare type IfNotNullable<T, K> = undefined extends T ? never : null extends T ? never : T extends never ? never : K;
+/**
+ * Evaluates to `K` if `T` isn't `never`.
+ */
+declare type IfNotNever<T, K> = T extends never ? never : K;
+export declare type SelectType<T> = T extends ColumnType<infer S, any, any> ? S : T;
+export declare type InsertType<T> = T extends ColumnType<any, infer I, any> ? I : T;
+export declare type UpdateType<T> = T extends ColumnType<any, any, infer U> ? U : T;
+/**
+ * Keys of `R` whose `InsertType` values can be `null` or `undefined`.
+ */
+export declare type NullableInsertKeys<R> = {
+    [K in keyof R]: IfNullable<InsertType<R[K]>, K>;
+}[keyof R];
+/**
+ * Keys of `R` whose `InsertType` values can't be `null` or `undefined`.
+ */
+export declare type NonNullableInsertKeys<R> = {
+    [K in keyof R]: IfNotNullable<InsertType<R[K]>, K>;
+}[keyof R];
+/**
+ * Keys of `R` whose `SelectType` values are not `never`
+ */
+declare type NonNeverSelectKeys<R> = {
+    [K in keyof R]: IfNotNever<SelectType<R[K]>, K>;
+}[keyof R];
+/**
+ * Keys of `R` whose `UpdateType` values are not `never`
+ */
+export declare type UpdateKeys<R> = {
+    [K in keyof R]: IfNotNever<UpdateType<R[K]>, K>;
+}[keyof R];
+/**
+ * Given a table interface, extracts the select type from all
+ * {@link ColumnType} types.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * interface PersonTable {
+ *   id: Generated<number>
+ *   first_name: string
+ *   modified_at: ColumnType<Date, string, never>
+ * }
+ *
+ * type Person = Selectable<PersonTable>
+ * // {
+ * //   id: number,
+ * //   first_name: string
+ * //   modified_at: Date
+ * // }
+ * ```
+ */
+export declare type Selectable<R> = {
+    [K in NonNeverSelectKeys<R>]: SelectType<R[K]>;
+};
+/**
+ * Given a table interface, extracts the insert type from all
+ * {@link ColumnType} types.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * interface PersonTable {
+ *   id: Generated<number>
+ *   first_name: string
+ *   modified_at: ColumnType<Date, string, never>
+ * }
+ *
+ * type InsertablePerson = Insertable<PersonTable>
+ * // {
+ * //   id?: number,
+ * //   first_name: string
+ * //   modified_at: string
+ * // }
+ * ```
+ */
+export declare type Insertable<R> = {
+    [K in NonNullableInsertKeys<R>]: InsertType<R[K]>;
+} & {
+    [K in NullableInsertKeys<R>]?: InsertType<R[K]>;
+};
+/**
+ * Given a table interface, extracts the update type from all
+ * {@link ColumnType} types.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * interface PersonTable {
+ *   id: Generated<number>
+ *   first_name: string
+ *   modified_at: ColumnType<Date, string, never>
+ * }
+ *
+ * type UpdateablePerson = Updateable<PersonTable>
+ * // {
+ * //   id?: number,
+ * //   first_name?: string
+ * // }
+ * ```
+ */
+export declare type Updateable<R> = {
+    [K in UpdateKeys<R>]?: UpdateType<R[K]>;
+};
+export {};

package/dist/cjs/util/column-type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/util/private-symbols.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @internal
+ * @private
+ */
+export declare const PRIVATE_ADAPTER: unique symbol;

package/dist/cjs/util/private-symbols.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRIVATE_ADAPTER = void 0;
+/**
+ * @internal
+ * @private
+ */
+exports.PRIVATE_ADAPTER = Symbol();

package/dist/cjs/util/type-utils.d.ts

@@ -8,42 +8,6 @@ import { UpdateResult } from '../query-builder/update-result.js';
  * Given an object type, extracts the union of all value types.
  */
 export declare type ValueType<T> = T[keyof T];
-/**
- * Given a database type and a union of table names returns the row type
- * that you would get by selecting all columns from tables TB.
- *
- * Example:
- *
- * ```ts
- * interface Person {
- *   id: number
- * }
- *
- * interface Pet {
- *   name: string
- *   species: 'cat' | 'dog'
- * }
- *
- * interface Movie {
- *   stars: number
- * }
- *
- * interface Database {
- *   person: Person
- *   pet: Pet
- *   movie: Movie
- * }
- *
- * type Row = RowType<Database, 'person' | 'movie'>
- *
- * // Row == Person & Movie
- * ```
- */
-export declare type RowType<DB, TB extends keyof DB> = {
-    [C in AnyColumn<DB, TB>]: {
-        [T in TB]: C extends keyof DB[T] ? DB[T][C] : never;
-    }[TB];
-};
 /**
  * Given a database type and a union of table names in that db, returns
  * a union type with all possible column names.
@@ -142,10 +106,6 @@ export declare type SelectQueryBuilderFactory<DB, TB extends keyof DB> = (qb: Ex
 export declare type AliasedQueryBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedQueryBuilder;
 export declare type RawBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyRawBuilder;
 export declare type AliasedRawBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedRawBuilder;
-export interface GeneratedPlaceholder {
-    /** @internal */
-    readonly __isGeneratedPlaceholder__: true;
-}
 export declare type SingleResultType<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O | undefined;
 export declare type UnknownRow = Record<string, unknown>;
 export declare type Nullable<T> = {

package/dist/esm/dialect/mysql/mysql-introspector.js

@@ -1,4 +1,4 @@
-import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migration.js';
+import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migrator.js';
 import { freeze } from '../../util/object-utils.js';
 export class MysqlIntrospector {
     #db;

package/dist/esm/dialect/postgres/postgres-introspector.js

@@ -1,4 +1,4 @@
-import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migration.js';
+import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migrator.js';
 import { freeze } from '../../util/object-utils.js';
 export class PostgresIntrospector {
     #db;

package/dist/esm/dialect/sqlite/sqlite-introspector.js

@@ -1,4 +1,4 @@
-import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migration.js';
+import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migrator.js';
 export class SqliteIntrospector {
     #db;
     constructor(db) {

package/dist/esm/index.d.ts

@@ -57,7 +57,8 @@ export * from './dialect/sqlite/sqlite-introspector.js';
 export * from './dialect/sqlite/sqlite-adapter.js';
 export * from './query-compiler/default-query-compiler.js';
 export * from './query-compiler/query-compiler.js';
-export * from './migration/migration.js';
+export * from './migration/migrator.js';
+export * from './migration/file-migration-provider.js';
 export * from './dialect/dialect.js';
 export * from './dialect/dialect-adapter.js';
 export * from './dialect/dialect-adapter-base.js';
@@ -138,6 +139,7 @@ export * from './operation-node/values-node.js';
 export * from './operation-node/where-node.js';
 export * from './operation-node/with-node.js';
 export * from './dialect/database-introspector.js';
+export * from './util/column-type.js';
 export * from './util/compilable.js';
 export * from './util/log.js';
 export { AnyColumn, UnknownRow, AnySelectQueryBuilder, } from './util/type-utils.js';

package/dist/esm/index.js

@@ -57,7 +57,8 @@ export * from './dialect/sqlite/sqlite-introspector.js';
 export * from './dialect/sqlite/sqlite-adapter.js';
 export * from './query-compiler/default-query-compiler.js';
 export * from './query-compiler/query-compiler.js';
-export * from './migration/migration.js';
+export * from './migration/migrator.js';
+export * from './migration/file-migration-provider.js';
 export * from './dialect/dialect.js';
 export * from './dialect/dialect-adapter.js';
 export * from './dialect/dialect-adapter-base.js';
@@ -138,5 +139,6 @@ export * from './operation-node/values-node.js';
 export * from './operation-node/where-node.js';
 export * from './operation-node/with-node.js';
 export * from './dialect/database-introspector.js';
+export * from './util/column-type.js';
 export * from './util/compilable.js';
 export * from './util/log.js';

package/dist/esm/kysely.d.ts

@@ -1,16 +1,16 @@
 import { Dialect } from './dialect/dialect.js';
 import { SchemaModule } from './schema/schema.js';
 import { DynamicModule } from './dynamic/dynamic.js';
-import { MigrationModule } from './migration/migration.js';
 import { QueryExecutor } from './query-executor/query-executor.js';
 import { QueryCreator } from './query-creator.js';
 import { KyselyPlugin } from './plugin/kysely-plugin.js';
-import { GeneratedPlaceholder } from './util/type-utils.js';
 import { DatabaseIntrospector } from './dialect/database-introspector.js';
 import { Driver, IsolationLevel } from './driver/driver.js';
 import { ParseContext } from './parser/parse-context.js';
 import { FunctionBuilder } from './query-builder/function-builder.js';
 import { LogConfig } from './util/log.js';
+import { PRIVATE_ADAPTER } from './util/private-symbols.js';
+import { DialectAdapter } from './dialect/dialect-adapter.js';
 /**
  * The main Kysely class.
  *
@@ -60,10 +60,6 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      * Returns the {@link SchemaModule} module for building database schema.
      */
     get schema(): SchemaModule;
-    /**
-     * Returns the {@link MigrationModule} module for managing and running migrations.
-     */
-    get migration(): MigrationModule;
     /**
      * Returns a the {@link DynamicModule} module.
      *
@@ -75,31 +71,6 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      * Returns a {@link DatabaseIntrospector | database introspector}.
      */
     get introspection(): DatabaseIntrospector;
-    /**
-     * A value to be used in place of columns that are generated in the database
-     * when inserting rows.
-     *
-     * ### Examples
-     *
-     * In this example the `Person` table has non-null properties `id` and `created_at`
-     * which are both automatically genereted by the database. Since their types are
-     * `number` and `string` respectively instead of `number | null` and `string | null`
-     * the `values` method requires you to give a value for them. the `generated`
-     * placeholder can be used in these cases.
-     *
-     * ```ts
-     * await db.insertInto('person')
-     *   .values({
-     *     id: db.generated,
-     *     created_at: db.generated,
-     *     first_name: 'Jennifer',
-     *     last_name: 'Aniston',
-     *     gender: 'female'
-     *   })
-     *   .execute()
-     * ```
-     */
-    get generated(): GeneratedPlaceholder;
     /**
      * Returns a {@link FunctionBuilder} that can be used to write type safe function
      * calls.
@@ -149,7 +120,6 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      * const catto = await db.transaction().execute(async (trx) => {
      *   const jennifer = await trx.insertInto('person')
      *     .values({
-     *       id: db.generated,
      *       first_name: 'Jennifer',
      *       last_name: 'Aniston',
      *     })
@@ -160,7 +130,6 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      *
      *   return await trx.insertInto('pet')
      *     .values({
-     *       id: db.generated,
      *       user_id: jennifer.id,
      *       name: 'Catto',
      *       species: 'cat'
@@ -251,6 +220,11 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      * You can also use `db instanceof Transaction`.
      */
     get isTransaction(): boolean;
+    /**
+     * @internal
+     * @private
+     */
+    get [PRIVATE_ADAPTER](): DialectAdapter;
 }
 export declare class Transaction<DB> extends Kysely<DB> {
     #private;
@@ -261,10 +235,6 @@ export declare class Transaction<DB> extends Kysely<DB> {
      * You can also use `db instanceof Transaction`.
      */
     get isTransaction(): true;
-    /**
-     * Returns the {@link MigrationModule} module for managing and running migrations.
-     */
-    get migration(): MigrationModule;
     /**
      * Creates a {@link TransactionBuilder} that can be used to run queries inside a transaction.
      *
@@ -285,7 +255,6 @@ export declare class Transaction<DB> extends Kysely<DB> {
      * const catto = await db.transaction().execute(async (trx) => {
      *   const jennifer = await trx.insertInto('person')
      *     .values({
-     *       id: db.generated,
      *       first_name: 'Jennifer',
      *       last_name: 'Aniston',
      *     })
@@ -296,7 +265,6 @@ export declare class Transaction<DB> extends Kysely<DB> {
      *
      *   return await trx.insertInto('pet')
      *     .values({
-     *       id: db.generated,
      *       user_id: jennifer.id,
      *       name: 'Catto',
      *       species: 'cat'

package/dist/esm/kysely.js

@@ -1,9 +1,7 @@
 import { SchemaModule } from './schema/schema.js';
 import { DynamicModule } from './dynamic/dynamic.js';
 import { DefaultConnectionProvider } from './driver/default-connection-provider.js';
-import { MigrationModule } from './migration/migration.js';
 import { QueryCreator } from './query-creator.js';
-import { GENERATED_PLACEHOLDER } from './util/generated-placeholder.js';
 import { DefaultQueryExecutor } from './query-executor/default-query-executor.js';
 import { freeze, isObject } from './util/object-utils.js';
 import { RuntimeDriver } from './driver/runtime-driver.js';
@@ -13,6 +11,7 @@ import { preventAwait } from './util/prevent-await.js';
 import { DefaultParseContext } from './parser/parse-context.js';
 import { FunctionBuilder } from './query-builder/function-builder.js';
 import { Log } from './util/log.js';
+import { PRIVATE_ADAPTER } from './util/private-symbols.js';
 /**
  * The main Kysely class.
  *
@@ -87,12 +86,6 @@ export class Kysely extends QueryCreator {
     get schema() {
         return new SchemaModule(this.#props.executor);
     }
-    /**
-     * Returns the {@link MigrationModule} module for managing and running migrations.
-     */
-    get migration() {
-        return new MigrationModule(this, this.#props.parseContext.adapter);
-    }
     /**
      * Returns a the {@link DynamicModule} module.
      *
@@ -108,33 +101,6 @@ export class Kysely extends QueryCreator {
     get introspection() {
         return this.#props.dialect.createIntrospector(this.withoutPlugins());
     }
-    /**
-     * A value to be used in place of columns that are generated in the database
-     * when inserting rows.
-     *
-     * ### Examples
-     *
-     * In this example the `Person` table has non-null properties `id` and `created_at`
-     * which are both automatically genereted by the database. Since their types are
-     * `number` and `string` respectively instead of `number | null` and `string | null`
-     * the `values` method requires you to give a value for them. the `generated`
-     * placeholder can be used in these cases.
-     *
-     * ```ts
-     * await db.insertInto('person')
-     *   .values({
-     *     id: db.generated,
-     *     created_at: db.generated,
-     *     first_name: 'Jennifer',
-     *     last_name: 'Aniston',
-     *     gender: 'female'
-     *   })
-     *   .execute()
-     * ```
-     */
-    get generated() {
-        return GENERATED_PLACEHOLDER;
-    }
     /**
      * Returns a {@link FunctionBuilder} that can be used to write type safe function
      * calls.
@@ -186,7 +152,6 @@ export class Kysely extends QueryCreator {
      * const catto = await db.transaction().execute(async (trx) => {
      *   const jennifer = await trx.insertInto('person')
      *     .values({
-     *       id: db.generated,
      *       first_name: 'Jennifer',
      *       last_name: 'Aniston',
      *     })
@@ -197,7 +162,6 @@ export class Kysely extends QueryCreator {
      *
      *   return await trx.insertInto('pet')
      *     .values({
-     *       id: db.generated,
      *       user_id: jennifer.id,
      *       name: 'Catto',
      *       species: 'cat'
@@ -308,6 +272,13 @@ export class Kysely extends QueryCreator {
     get isTransaction() {
         return false;
     }
+    /**
+     * @internal
+     * @private
+     */
+    get [PRIVATE_ADAPTER]() {
+        return this.#props.parseContext.adapter;
+    }
 }
 export class Transaction extends Kysely {
     #props;
@@ -321,9 +292,6 @@ export class Transaction extends Kysely {
     get isTransaction() {
         return true;
     }
-    get migration() {
-        throw new Error('the migration module is not available for a transaction. Use the main Kysely instance to run migrations');
-    }
     transaction() {
         throw new Error('calling the transaction method for a Transaction is not supported');
     }

package/dist/esm/migration/file-migration-provider.d.ts

@@ -0,0 +1,52 @@
+import { Migration, MigrationProvider } from './migrator.js';
+/**
+ * A function that takes a folder path and returns names of the
+ * files insider that folder.
+ */
+export declare type ReadDir = (migrationFolderPath: string) => Promise<string[]>;
+/**
+ * A function that combines two file path parts into a single file path.
+ *
+ * ```ts
+ * joinPath('/some/path', 'file.ts')
+ * // ==> '/some/path/file.ts'
+ * ```
+ */
+export declare type JoinPath = (part1: string, part2: string) => string;
+/**
+ * Reads all migrations from a folder.
+ *
+ * You need to provide a function for reading files in a folder and a function for
+ * joining file paths together. The API is like this to make Kysely independent of
+ * node.js or any other environment. See the example usage on node.js below.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * import * as path from 'path'
+ * import * as fs from 'fs/promises'
+ *
+ * new FileMigrationProvider(
+ *   fs.readdir,
+ *   path.join,
+ *   path.join(__dirname, 'migrations')
+ * )
+ * ```
+ */
+export declare class FileMigrationProvider implements MigrationProvider {
+    #private;
+    constructor(readDir: ReadDir, joinPath: JoinPath, migrationFolderPath: string);
+    /**
+     * Returns all migrations, old and new.
+     *
+     * For example if you have your migrations in a folder as separate files,
+     * you can use the {@link FileMigrationProvider} that implements this
+     * method to return all migrations in a folder.
+     *
+     * The keys of the returned object are migration names and values are the
+     * migrations. The order of the migrations is determined by the alphabetical
+     * order of the migration names. The items in the object don't need to be
+     * sorted, they are sorted by Kysely.
+     */
+    getMigrations(): Promise<Record<string, Migration>>;
+}