kysely 0.18.1 → 0.19.0

package/dist/cjs/index.js

@@ -14,14 +14,154 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./index-nodeless.js"), exports);
-__exportStar(require("./migration/file-migration-provider.js"), exports);
+__exportStar(require("./kysely.js"), exports);
+__exportStar(require("./query-creator.js"), exports);
+__exportStar(require("./query-builder/where-interface.js"), exports);
+__exportStar(require("./query-builder/join-interface.js"), exports);
+__exportStar(require("./query-builder/returning-interface.js"), exports);
+__exportStar(require("./query-builder/having-interface.js"), exports);
+__exportStar(require("./query-builder/select-query-builder.js"), exports);
+__exportStar(require("./query-builder/insert-query-builder.js"), exports);
+__exportStar(require("./query-builder/update-query-builder.js"), exports);
+__exportStar(require("./query-builder/delete-query-builder.js"), exports);
+__exportStar(require("./query-builder/no-result-error.js"), exports);
+__exportStar(require("./query-builder/join-builder.js"), exports);
+__exportStar(require("./query-builder/expression-builder.js"), exports);
+__exportStar(require("./query-builder/function-builder.js"), exports);
+__exportStar(require("./query-builder/insert-result.js"), exports);
+__exportStar(require("./query-builder/delete-result.js"), exports);
+__exportStar(require("./query-builder/update-result.js"), exports);
+__exportStar(require("./query-builder/on-conflict-builder.js"), exports);
+__exportStar(require("./raw-builder/raw-builder.js"), exports);
+__exportStar(require("./raw-builder/sql.js"), exports);
+__exportStar(require("./query-executor/query-executor.js"), exports);
+__exportStar(require("./query-executor/default-query-executor.js"), exports);
+__exportStar(require("./query-executor/noop-query-executor.js"), exports);
+__exportStar(require("./query-executor/query-executor-provider.js"), exports);
+__exportStar(require("./query-compiler/default-query-compiler.js"), exports);
+__exportStar(require("./query-compiler/compiled-query.js"), exports);
+__exportStar(require("./schema/schema.js"), exports);
+__exportStar(require("./schema/create-table-builder.js"), exports);
+__exportStar(require("./schema/drop-table-builder.js"), exports);
+__exportStar(require("./schema/create-index-builder.js"), exports);
+__exportStar(require("./schema/drop-index-builder.js"), exports);
+__exportStar(require("./schema/create-schema-builder.js"), exports);
+__exportStar(require("./schema/drop-schema-builder.js"), exports);
+__exportStar(require("./schema/column-definition-builder.js"), exports);
+__exportStar(require("./schema/foreign-key-constraint-builder.js"), exports);
+__exportStar(require("./schema/alter-table-builder.js"), exports);
+__exportStar(require("./schema/create-view-builder.js"), exports);
+__exportStar(require("./schema/drop-view-builder.js"), exports);
+__exportStar(require("./dynamic/dynamic.js"), exports);
+__exportStar(require("./driver/driver.js"), exports);
+__exportStar(require("./driver/database-connection.js"), exports);
+__exportStar(require("./driver/connection-provider.js"), exports);
+__exportStar(require("./driver/default-connection-provider.js"), exports);
+__exportStar(require("./driver/single-connection-provider.js"), exports);
+__exportStar(require("./driver/dummy-driver.js"), exports);
+__exportStar(require("./dialect/dialect.js"), exports);
+__exportStar(require("./dialect/dialect-adapter.js"), exports);
+__exportStar(require("./dialect/dialect-adapter-base.js"), exports);
+__exportStar(require("./dialect/database-introspector.js"), exports);
 __exportStar(require("./dialect/sqlite/sqlite-dialect.js"), exports);
 __exportStar(require("./dialect/sqlite/sqlite-dialect-config.js"), exports);
 __exportStar(require("./dialect/sqlite/sqlite-driver.js"), exports);
+__exportStar(require("./dialect/postgres/postgres-query-compiler.js"), exports);
+__exportStar(require("./dialect/postgres/postgres-introspector.js"), exports);
+__exportStar(require("./dialect/postgres/postgres-adapter.js"), exports);
 __exportStar(require("./dialect/mysql/mysql-dialect.js"), exports);
 __exportStar(require("./dialect/mysql/mysql-dialect-config.js"), exports);
 __exportStar(require("./dialect/mysql/mysql-driver.js"), exports);
+__exportStar(require("./dialect/mysql/mysql-query-compiler.js"), exports);
+__exportStar(require("./dialect/mysql/mysql-introspector.js"), exports);
+__exportStar(require("./dialect/mysql/mysql-adapter.js"), exports);
 __exportStar(require("./dialect/postgres/postgres-driver.js"), exports);
 __exportStar(require("./dialect/postgres/postgres-dialect-config.js"), exports);
 __exportStar(require("./dialect/postgres/postgres-dialect.js"), exports);
+__exportStar(require("./dialect/sqlite/sqlite-query-compiler.js"), exports);
+__exportStar(require("./dialect/sqlite/sqlite-introspector.js"), exports);
+__exportStar(require("./dialect/sqlite/sqlite-adapter.js"), exports);
+__exportStar(require("./query-compiler/default-query-compiler.js"), exports);
+__exportStar(require("./query-compiler/query-compiler.js"), exports);
+__exportStar(require("./migration/migrator.js"), exports);
+__exportStar(require("./migration/file-migration-provider.js"), exports);
+__exportStar(require("./plugin/kysely-plugin.js"), exports);
+__exportStar(require("./plugin/camel-case/camel-case-plugin.js"), exports);
+__exportStar(require("./plugin/deduplicate-joins/deduplicate-joins-plugin.js"), exports);
+__exportStar(require("./operation-node/add-column-node.js"), exports);
+__exportStar(require("./operation-node/add-constraint-node.js"), exports);
+__exportStar(require("./operation-node/alias-node.js"), exports);
+__exportStar(require("./operation-node/alter-column-node.js"), exports);
+__exportStar(require("./operation-node/alter-table-node.js"), exports);
+__exportStar(require("./operation-node/and-node.js"), exports);
+__exportStar(require("./operation-node/check-constraint-node.js"), exports);
+__exportStar(require("./operation-node/column-definition-node.js"), exports);
+__exportStar(require("./operation-node/column-node.js"), exports);
+__exportStar(require("./operation-node/column-update-node.js"), exports);
+__exportStar(require("./operation-node/common-table-expression-node.js"), exports);
+__exportStar(require("./operation-node/common-table-expression-name-node.js"), exports);
+__exportStar(require("./operation-node/constraint-node.js"), exports);
+__exportStar(require("./operation-node/create-index-node.js"), exports);
+__exportStar(require("./operation-node/create-schema-node.js"), exports);
+__exportStar(require("./operation-node/create-table-node.js"), exports);
+__exportStar(require("./operation-node/create-view-node.js"), exports);
+__exportStar(require("./operation-node/data-type-node.js"), exports);
+__exportStar(require("./operation-node/default-value-node.js"), exports);
+__exportStar(require("./operation-node/delete-query-node.js"), exports);
+__exportStar(require("./operation-node/drop-column-node.js"), exports);
+__exportStar(require("./operation-node/drop-constraint-node.js"), exports);
+__exportStar(require("./operation-node/drop-index-node.js"), exports);
+__exportStar(require("./operation-node/drop-schema-node.js"), exports);
+__exportStar(require("./operation-node/drop-table-node.js"), exports);
+__exportStar(require("./operation-node/drop-view-node.js"), exports);
+__exportStar(require("./operation-node/filter-node.js"), exports);
+__exportStar(require("./operation-node/foreign-key-constraint-node.js"), exports);
+__exportStar(require("./operation-node/from-node.js"), exports);
+__exportStar(require("./operation-node/generated-node.js"), exports);
+__exportStar(require("./operation-node/group-by-item-node.js"), exports);
+__exportStar(require("./operation-node/group-by-node.js"), exports);
+__exportStar(require("./operation-node/having-node.js"), exports);
+__exportStar(require("./operation-node/identifier-node.js"), exports);
+__exportStar(require("./operation-node/insert-query-node.js"), exports);
+__exportStar(require("./operation-node/join-node.js"), exports);
+__exportStar(require("./operation-node/limit-node.js"), exports);
+__exportStar(require("./operation-node/list-node.js"), exports);
+__exportStar(require("./operation-node/modify-column-node.js"), exports);
+__exportStar(require("./operation-node/offset-node.js"), exports);
+__exportStar(require("./operation-node/on-conflict-node.js"), exports);
+__exportStar(require("./operation-node/on-duplicate-key-node.js"), exports);
+__exportStar(require("./operation-node/on-node.js"), exports);
+__exportStar(require("./operation-node/operation-node-source.js"), exports);
+__exportStar(require("./operation-node/operation-node-transformer.js"), exports);
+__exportStar(require("./operation-node/operation-node-utils.js"), exports);
+__exportStar(require("./operation-node/operation-node-visitor.js"), exports);
+__exportStar(require("./operation-node/operation-node.js"), exports);
+__exportStar(require("./operation-node/operator-node.js"), exports);
+__exportStar(require("./operation-node/or-node.js"), exports);
+__exportStar(require("./operation-node/order-by-item-node.js"), exports);
+__exportStar(require("./operation-node/order-by-node.js"), exports);
+__exportStar(require("./operation-node/parens-node.js"), exports);
+__exportStar(require("./operation-node/primary-constraint-node.js"), exports);
+__exportStar(require("./operation-node/primitive-value-list-node.js"), exports);
+__exportStar(require("./operation-node/query-node.js"), exports);
+__exportStar(require("./operation-node/raw-node.js"), exports);
+__exportStar(require("./operation-node/reference-node.js"), exports);
+__exportStar(require("./operation-node/references-node.js"), exports);
+__exportStar(require("./operation-node/rename-column-node.js"), exports);
+__exportStar(require("./operation-node/returning-node.js"), exports);
+__exportStar(require("./operation-node/select-all-node.js"), exports);
+__exportStar(require("./operation-node/select-query-node.js"), exports);
+__exportStar(require("./operation-node/select-query-node.js"), exports);
+__exportStar(require("./operation-node/selection-node.js"), exports);
+__exportStar(require("./operation-node/table-node.js"), exports);
+__exportStar(require("./operation-node/union-node.js"), exports);
+__exportStar(require("./operation-node/unique-constraint-node.js"), exports);
+__exportStar(require("./operation-node/update-query-node.js"), exports);
+__exportStar(require("./operation-node/value-list-node.js"), exports);
+__exportStar(require("./operation-node/value-node.js"), exports);
+__exportStar(require("./operation-node/values-node.js"), exports);
+__exportStar(require("./operation-node/where-node.js"), exports);
+__exportStar(require("./operation-node/with-node.js"), exports);
+__exportStar(require("./util/column-type.js"), exports);
+__exportStar(require("./util/compilable.js"), exports);
+__exportStar(require("./util/log.js"), exports);

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

@@ -1,18 +1,23 @@
 import { Migration, MigrationProvider } from './migrator.js';
 /**
- * Reads all migrations from a folder.
+ * Reads all migrations from a folder in node.js.
  *
  * ### Examples
  *
  * ```ts
- * new FileMigrationProvider(
- *   'path/to/migrations/folder'
- * )
+ * import { promises as fs } from 'fs'
+ * import path from 'path'
+ *
+ * new FileMigrationProvider({
+ *   fs,
+ *   path,
+ *   migrationFolder: 'path/to/migrations/folder'
+ * })
  * ```
  */
 export declare class FileMigrationProvider implements MigrationProvider {
     #private;
-    constructor(migrationFolderPath: string);
+    constructor(props: FileMigrationProviderProps);
     /**
      * Returns all migrations, old and new.
      *
@@ -27,3 +32,14 @@ export declare class FileMigrationProvider implements MigrationProvider {
      */
     getMigrations(): Promise<Record<string, Migration>>;
 }
+export interface FileMigrationProviderFS {
+    readdir(path: string): Promise<string[]>;
+}
+export interface FileMigrationProviderPath {
+    join(...path: string[]): string;
+}
+export interface FileMigrationProviderProps {
+    fs: FileMigrationProviderFS;
+    path: FileMigrationProviderPath;
+    migrationFolder: string;
+}

package/dist/cjs/migration/file-migration-provider.js

@@ -3,32 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileMigrationProvider = void 0;
 const object_utils_js_1 = require("../util/object-utils.js");
 /**
- * Reads all migrations from a folder.
+ * Reads all migrations from a folder in node.js.
  *
  * ### Examples
  *
  * ```ts
- * new FileMigrationProvider(
- *   'path/to/migrations/folder'
- * )
+ * import { promises as fs } from 'fs'
+ * import path from 'path'
+ *
+ * new FileMigrationProvider({
+ *   fs,
+ *   path,
+ *   migrationFolder: 'path/to/migrations/folder'
+ * })
  * ```
  */
 class FileMigrationProvider {
-    #migrationFolderPath;
-    constructor(migrationFolderPath) {
-        this.#migrationFolderPath = migrationFolderPath;
+    #props;
+    constructor(props) {
+        this.#props = props;
     }
     async getMigrations() {
-        // Import these dynamically so that we don't have any top level
-        // node dependencies.
-        const fs = await Promise.resolve().then(() => require('fs/promises'));
-        const path = await Promise.resolve().then(() => require('path'));
         const migrations = {};
-        const files = await fs.readdir(this.#migrationFolderPath);
+        const files = await this.#props.fs.readdir(this.#props.migrationFolder);
         for (const fileName of files) {
             if ((fileName.endsWith('.js') || fileName.endsWith('.ts')) &&
                 !fileName.endsWith('.d.ts')) {
-                const migration = await Promise.resolve().then(() => require(path.join(this.#migrationFolderPath, fileName)));
+                const migration = await Promise.resolve().then(() => require(this.#props.path.join(this.#props.migrationFolder, fileName)));
                 if (isMigration(migration)) {
                     migrations[fileName.substring(0, fileName.length - 3)] = migration;
                 }

package/dist/cjs/plugin/noop-plugin.d.ts

@@ -1,6 +1,6 @@
 import { QueryResult } from '../driver/database-connection.js';
-import { UnknownRow } from '../index-nodeless.js';
 import { RootOperationNode } from '../query-compiler/query-compiler.js';
+import { UnknownRow } from '../util/type-utils.js';
 import { KyselyPlugin, PluginTransformQueryArgs, PluginTransformResultArgs } from './kysely-plugin.js';
 export declare class NoopPlugin implements KyselyPlugin {
     /**

package/dist/esm/dialect/mysql/mysql-dialect-config.d.ts

@@ -2,223 +2,40 @@ import { DatabaseConnection } from '../../driver/database-connection.js';
 /**
  * Config for the MySQL dialect.
  *
- * This interface is equal to `mysql2` library's pool config.
- *
  * https://github.com/sidorares/node-mysql2#using-connection-pools
  */
 export interface MysqlDialectConfig {
     /**
-     * The MySQL user to authenticate as
-     */
-    user?: string;
-    /**
-     * The password of that MySQL user
-     */
-    password?: string;
-    /**
-     * Name of the database to use for this connection
-     */
-    database?: string;
-    /**
-     * The charset for the connection. This is called 'collation' in the SQL-level of MySQL (like utf8_general_ci).
-     * If a SQL-level charset is specified (like utf8mb4) then the default collation for that charset is used.
-     * (Default: 'UTF8_GENERAL_CI')
-     */
-    charset?: string;
-    /**
-     * The hostname of the database you are connecting to. (Default: localhost)
-     */
-    host?: string;
-    /**
-     * The port number to connect to. (Default: 3306)
-     */
-    port?: number;
-    /**
-     * The source IP address to use for TCP connection
-     */
-    localAddress?: string;
-    /**
-     * The path to a unix domain socket to connect to. When used host and port are ignored
-     */
-    socketPath?: string;
-    /**
-     * The timezone used to store local dates. (Default: 'local')
-     */
-    timezone?: string | 'local';
-    /**
-     * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10 seconds)
-     */
-    connectTimeout?: number;
-    /**
-     * Stringify objects instead of converting to values. (Default: 'false')
-     */
-    stringifyObjects?: boolean;
-    /**
-     * Allow connecting to MySQL instances that ask for the old (insecure) authentication method. (Default: false)
-     */
-    insecureAuth?: boolean;
-    /**
-     * Determines if column values should be converted to native JavaScript types. It is not recommended (and may go away / change in the future)
-     * to disable type casting, but you can currently do so on either the connection or query level. (Default: true)
-     *
-     * You can also specify a function (field: any, next: () => void) => {} to do the type casting yourself.
-     *
-     * WARNING: YOU MUST INVOKE the parser using one of these three field functions in your custom typeCast callback. They can only be called once.
-     *
-     * field.string()
-     * field.buffer()
-     * field.geometry()
-     *
-     * are aliases for
-     *
-     * parser.parseLengthCodedString()
-     * parser.parseLengthCodedBuffer()
-     * parser.parseGeometryValue()
-     *
-     * You can find which field function you need to use by looking at: RowDataPacket.prototype._typeCast
-     */
-    typeCast?: boolean | ((field: any, next: () => void) => any);
-    /**
-     * A custom query format function
-     */
-    queryFormat?: (query: string, values: any) => void;
-    /**
-     * When dealing with big numbers (BIGINT and DECIMAL columns) in the database, you should enable this option
-     * (Default: false)
-     */
-    supportBigNumbers?: boolean;
-    /**
-     * Enabling both supportBigNumbers and bigNumberStrings forces big numbers (BIGINT and DECIMAL columns) to be
-     * always returned as JavaScript String objects (Default: false). Enabling supportBigNumbers but leaving
-     * bigNumberStrings disabled will return big numbers as String objects only when they cannot be accurately
-     * represented with [JavaScript Number objects] (http://ecma262-5.com/ELS5_HTML.htm#Section_8.5)
-     * (which happens when they exceed the [-2^53, +2^53] range), otherwise they will be returned as Number objects.
-     * This option is ignored if supportBigNumbers is disabled.
-     */
-    bigNumberStrings?: boolean;
-    /**
-     * Force date types (TIMESTAMP, DATETIME, DATE) to be returned as strings rather then inflated into JavaScript Date
-     * objects. Can be true/false or an array of type names to keep as strings.
+     * A mysql2 Pool instance or a function that returns one.
      *
-     * (Default: false)
-     */
-    dateStrings?: boolean | Array<'TIMESTAMP' | 'DATETIME' | 'DATE'>;
-    /**
-     * This will print all incoming and outgoing packets on stdout.
-     * You can also restrict debugging to packet types by passing an array of types (strings) to debug;
+     * If a function is provided, it's called once when the first query is executed.
      *
-     * (Default: false)
+     * https://github.com/sidorares/node-mysql2#using-connection-pools
      */
-    debug?: any;
-    /**
-     * Generates stack traces on Error to include call site of library entrance ('long stack traces'). Slight
-     * performance penalty for most calls. (Default: true)
-     */
-    trace?: boolean;
-    /**
-     * Allow multiple MySQL statements per query. Be careful with this, it exposes you to SQL injection attacks. (Default: false)
-     */
-    multipleStatements?: boolean;
-    /**
-     * List of connection flags to use other than the default ones. It is also possible to blacklist default ones
-     */
-    flags?: Array<string>;
-    /**
-     * object with ssl parameters or a string containing name of ssl profile
-     */
-    ssl?: string | MysqlSslOptions;
-    /**
-     * Return each row as an array, not as an object.
-     * This is useful when you have duplicate column names.
-     * This can also be set in the `QueryOption` object to be applied per-query.
-     */
-    rowsAsArray?: boolean;
-    /**
-     * The milliseconds before a timeout occurs during the connection acquisition. This is slightly different from connectTimeout,
-     * because acquiring a pool connection does not always involve making a connection. (Default: 10 seconds)
-     */
-    acquireTimeout?: number;
-    /**
-     * Determines the pool's action when no connections are available and the limit has been reached. If true, the pool will queue
-     * the connection request and call it when one becomes available. If false, the pool will immediately call back with an error.
-     * (Default: true)
-     */
-    waitForConnections?: boolean;
-    /**
-     * The maximum number of connections to create at once. (Default: 10)
-     */
-    connectionLimit?: number;
-    /**
-     * The maximum number of connection requests the pool will queue before returning an error from getConnection. If set to 0, there
-     * is no limit to the number of queued connection requests. (Default: 0)
-     */
-    queueLimit?: number;
-    /**
-     * Enable keep-alive on the socket.  It's disabled by default, but the
-     * user can enable it and supply an initial delay.
-     */
-    enableKeepAlive?: true;
-    /**
-     * If keep-alive is enabled users can supply an initial delay.
-     */
-    keepAliveInitialDelay?: number;
-    charsetNumber?: number;
-    compress?: boolean;
-    authSwitchHandler?: (data: any, callback: () => void) => any;
-    connectAttributes?: {
-        [param: string]: any;
-    };
-    decimalNumbers?: boolean;
-    isServer?: boolean;
-    maxPreparedStatements?: number;
-    namedPlaceholders?: boolean;
-    nestTables?: boolean | string;
-    passwordSha1?: string;
-    pool?: any;
-    stream?: any;
-    uri?: string;
-    Promise?: any;
-    authPlugins?: {
-        [key: string]: any;
-    };
+    pool: MysqlPool | (() => Promise<MysqlPool>);
     /**
      * Called once for each created connection.
-     *
-     * This is a Kysely specific feature and does not come from the `mysql2` module.
      */
     onCreateConnection?: (connection: DatabaseConnection) => Promise<void>;
 }
-export interface MysqlSslOptions {
-    /**
-     * A string or buffer holding the PFX or PKCS12 encoded private key, certificate and CA certificates
-     */
-    pfx?: string;
-    /**
-     * A string holding the PEM encoded private key
-     */
-    key?: string;
-    /**
-     * A string of passphrase for the private key or pfx
-     */
-    passphrase?: string;
-    /**
-     * A string holding the PEM encoded certificate
-     */
-    cert?: string;
-    /**
-     * Either a string or list of strings of PEM encoded CA certificates to trust.
-     */
-    ca?: string | string[];
-    /**
-     * Either a string or list of strings of PEM encoded CRLs (Certificate Revocation List)
-     */
-    crl?: string | string[];
-    /**
-     * A string describing the ciphers to use or exclude
-     */
-    ciphers?: string;
-    /**
-     * You can also connect to a MySQL server without properly providing the appropriate CA to trust. You should not do this.
-     */
-    rejectUnauthorized?: boolean;
+/**
+ * This interface is the subset of mysql2 driver's `Pool` class that
+ * kysely needs.
+ *
+ * We don't use the type from `mysql2` here to not have a dependency to it.
+ *
+ * https://github.com/sidorares/node-mysql2#using-connection-pools
+ */
+export interface MysqlPool {
+    getConnection(callback: (error: unknown, connection: MysqlPoolConnection) => void): void;
+    end(callback: (error: unknown) => void): void;
+}
+export interface MysqlPoolConnection {
+    query(sql: string, parameters: ReadonlyArray<unknown>, callback: (error: unknown, result: MysqlQueryResult) => void): void;
+    release(): void;
+}
+export interface MysqlOkPacket {
+    affectedRows: number;
+    insertId: number;
 }
+export declare type MysqlQueryResult = MysqlOkPacket | Record<string, unknown>[];

package/dist/esm/dialect/mysql/mysql-dialect.d.ts

@@ -3,26 +3,41 @@ import { Kysely } from '../../kysely.js';
 import { QueryCompiler } from '../../query-compiler/query-compiler.js';
 import { Dialect } from '../dialect.js';
 import { DatabaseIntrospector } from '../database-introspector.js';
-import { MysqlPool } from './mysql-driver.js';
 import { DialectAdapter } from '../dialect-adapter.js';
 import { MysqlDialectConfig } from './mysql-dialect-config.js';
 /**
  * MySQL dialect that uses the [mysql2](https://github.com/sidorares/node-mysql2#readme) library.
  *
- * The {@link MysqlDialectConfig | configuration} passed to the constructor
- * is given as-is to the mysql2 library's [createPool](https://github.com/sidorares/node-mysql2#using-connection-pools)
- * method.
+ * The constructor takes an instance of {@link MysqlDialectConfig}.
  *
- * You can also provide an existing mysql2 `Pool` instance:
+ * ```ts
+ * import { createPool } from 'mysql2'
+ *
+ * new MysqlDialect({
+ *   pool: createPool({
+ *     database: 'some_db',
+ *     host: 'localhost',
+ *   })
+ * })
+ * ```
+ *
+ * If you want the pool to only be created once it's first used, `pool`
+ * can be a function:
  *
  * ```ts
  * import { createPool } from 'mysql2'
- * new MysqlDialect(createPool(config))
+ *
+ * new MysqlDialect({
+ *   pool: async () => createPool({
+ *     database: 'some_db',
+ *     host: 'localhost',
+ *   })
+ * })
  * ```
  */
 export declare class MysqlDialect implements Dialect {
     #private;
-    constructor(configOrPool: MysqlDialectConfig | MysqlPool);
+    constructor(config: MysqlDialectConfig);
     /**
      * Creates a driver for the dialect.
      */

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

@@ -6,24 +6,40 @@ import { MysqlAdapter } from './mysql-adapter.js';
 /**
  * MySQL dialect that uses the [mysql2](https://github.com/sidorares/node-mysql2#readme) library.
  *
- * The {@link MysqlDialectConfig | configuration} passed to the constructor
- * is given as-is to the mysql2 library's [createPool](https://github.com/sidorares/node-mysql2#using-connection-pools)
- * method.
+ * The constructor takes an instance of {@link MysqlDialectConfig}.
  *
- * You can also provide an existing mysql2 `Pool` instance:
+ * ```ts
+ * import { createPool } from 'mysql2'
+ *
+ * new MysqlDialect({
+ *   pool: createPool({
+ *     database: 'some_db',
+ *     host: 'localhost',
+ *   })
+ * })
+ * ```
+ *
+ * If you want the pool to only be created once it's first used, `pool`
+ * can be a function:
  *
  * ```ts
  * import { createPool } from 'mysql2'
- * new MysqlDialect(createPool(config))
+ *
+ * new MysqlDialect({
+ *   pool: async () => createPool({
+ *     database: 'some_db',
+ *     host: 'localhost',
+ *   })
+ * })
  * ```
  */
 export class MysqlDialect {
-    #configOrPool;
-    constructor(configOrPool) {
-        this.#configOrPool = configOrPool;
+    #config;
+    constructor(config) {
+        this.#config = config;
     }
     createDriver() {
-        return new MysqlDriver(this.#configOrPool);
+        return new MysqlDriver(this.#config);
     }
     createQueryCompiler() {
         return new MysqlQueryCompiler();

package/dist/esm/dialect/mysql/mysql-driver.d.ts

@@ -1,11 +1,11 @@
 import { DatabaseConnection, QueryResult } from '../../driver/database-connection.js';
 import { Driver, TransactionSettings } from '../../driver/driver.js';
 import { CompiledQuery } from '../../query-compiler/compiled-query.js';
-import { MysqlDialectConfig } from './mysql-dialect-config.js';
+import { MysqlDialectConfig, MysqlPoolConnection } from './mysql-dialect-config.js';
 declare const PRIVATE_RELEASE_METHOD: unique symbol;
 export declare class MysqlDriver implements Driver {
     #private;
-    constructor(configOrPool: MysqlDialectConfig | MysqlPool);
+    constructor(configOrPool: MysqlDialectConfig);
     /**
      * Initializes the driver.
      *
@@ -43,19 +43,6 @@ export declare class MysqlDriver implements Driver {
      */
     destroy(): Promise<void>;
 }
-export interface MysqlPool {
-    getConnection(callback: (error: unknown, connection: MysqlPoolConnection) => void): void;
-    end(callback: (error: unknown) => void): void;
-}
-interface MysqlPoolConnection {
-    query(sql: string, parameters: ReadonlyArray<unknown>, callback: (error: unknown, result: MysqlQueryResult) => void): void;
-    release(): void;
-}
-interface MysqlOkPacket {
-    affectedRows: number;
-    insertId: number;
-}
-declare type MysqlQueryResult = MysqlOkPacket | Record<string, unknown>[];
 declare class MysqlConnection implements DatabaseConnection {
     #private;
     constructor(rawConnection: MysqlPoolConnection);