kysely 0.18.1 → 0.19.0

package/README.md

@@ -70,6 +70,7 @@ All you need to do is define an interface for each table in the database and pas
 interfaces to the `Kysely` constructor:
 
 ```ts
+import { Pool } from 'pg'
 import {
   Kysely,
   PostgresDialect,
@@ -125,9 +126,11 @@ interface Database {
 const db = new Kysely<Database>({
   // Use MysqlDialect for MySQL and SqliteDialect for SQLite.
   dialect: new PostgresDialect({
-    host: 'localhost',
-    database: 'kysely_test',
-  }),
+    pool: new Pool({
+      host: 'localhost',
+      database: 'kysely_test'
+    })
+  })
 })
 
 async function demo() {
@@ -319,6 +322,9 @@ need to depend on a typescript compiler, which most production environments don'
 have. You will probably want to add a simple migration script to your projects like this:
 
 ```ts
+import * as path from 'path'
+import { Pool } from 'pg'
+import { promises: fs } from 'fs'
 import {
   Kysely,
   Migrator,
@@ -329,17 +335,20 @@ import {
 async function migrateToLatest() {
   const db = new Kysely<Database>({
     dialect: new PostgresDialect({
-      host: 'localhost',
-      database: 'kysely_test',
+      pool: new Pool({
+        host: 'localhost',
+        database: 'kysely_test',
+      })
     }),
   })
 
   const migrator = new Migrator({
     db,
-    provider: new FileMigrationProvider(
-      // Path to the folder that contains all your migrations.
-      'some/path/to/migrations'
-    )
+    provider: new FileMigrationProvider({
+      fs,
+      path,
+      migrationFolder: 'some/path/to/migrations',
+    })
   })
 
   const { error, results } = await migrator.migrateToLatest()
@@ -376,9 +385,7 @@ Kysely doesn't include drivers for deno, but you can still use Kysely as a query
 or implement your own driver:
 
 ```ts
-// We use jsdeliver to get Kysely from npm. We also need to
-// import the `dist/esm/index-nodeless.js` file instead of the
-// root which has node dependencies.
+// We use jsdeliver to get Kysely from npm.
 import {
   DummyDriver,
   Generated,
@@ -386,7 +393,7 @@ import {
   PostgresAdapter,
   PostgresIntrospector,
   PostgresQueryCompiler,
-} from 'https://cdn.jsdelivr.net/npm/kysely/dist/esm/index-nodeless.js'
+} from 'https://cdn.jsdelivr.net/npm/kysely/dist/esm/index.js'
 
 interface Person {
   id: Generated<number>
@@ -425,9 +432,7 @@ console.log(sql.sql)
 
 # Browser
 
-Kysely also runs in the browser as long as you import the `dist/esm/index-nodeless.js`
-module instead of the root that has node dependencies. You can also import the
-`dist/cjs/index-nodeless.js` file if you are using commonjs modules instead of ESM.
+Kysely also runs in the browser:
 
 ```ts
 import {
@@ -437,7 +442,7 @@ import {
   SqliteAdapter,
   SqliteIntrospector,
   SqliteQueryCompiler,
-} from 'kysely/dist/esm/index-nodeless.js'
+} from 'kysely'
 
 interface Person {
   id: Generated<number>

package/dist/cjs/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/cjs/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/cjs/dialect/mysql/mysql-dialect.js

@@ -8,24 +8,40 @@ const mysql_adapter_js_1 = require("./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',
+ *   })
+ * })
  * ```
  */
 class MysqlDialect {
-    #configOrPool;
-    constructor(configOrPool) {
-        this.#configOrPool = configOrPool;
+    #config;
+    constructor(config) {
+        this.#config = config;
     }
     createDriver() {
-        return new mysql_driver_js_1.MysqlDriver(this.#configOrPool);
+        return new mysql_driver_js_1.MysqlDriver(this.#config);
     }
     createQueryCompiler() {
         return new mysql_query_compiler_js_1.MysqlQueryCompiler();

package/dist/cjs/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);

package/dist/cjs/dialect/mysql/mysql-driver.js

@@ -10,23 +10,12 @@ class MysqlDriver {
     #connections = new WeakMap();
     #pool;
     constructor(configOrPool) {
-        if (isMysqlPool(configOrPool)) {
-            this.#pool = configOrPool;
-        }
-        else {
-            this.#config = (0, object_utils_js_1.freeze)({ ...configOrPool });
-        }
+        this.#config = (0, object_utils_js_1.freeze)({ ...configOrPool });
     }
     async init() {
-        if (this.#config) {
-            // Import the `mysql2` module here instead at the top of the file
-            // so that this file can be loaded by node without `mysql2` driver
-            // installed.
-            const poolFactory = await importMysqlPoolFactory();
-            // Use the `mysql2` module's own pool. All drivers should use the
-            // pool provided by the database library if possible.
-            this.#pool = poolFactory(this.#config);
-        }
+        this.#pool = (0, object_utils_js_1.isFunction)(this.#config.pool)
+            ? await this.#config.pool()
+            : this.#config.pool;
     }
     async acquireConnection() {
         const rawConnection = await this.#acquireConnection();
@@ -85,29 +74,9 @@ class MysqlDriver {
     }
 }
 exports.MysqlDriver = MysqlDriver;
-function isMysqlPool(obj) {
-    return (0, object_utils_js_1.isObject)(obj) && (0, object_utils_js_1.isFunction)(obj.getConnection) && (0, object_utils_js_1.isFunction)(obj.end);
-}
 function isOkPacket(obj) {
     return (0, object_utils_js_1.isObject)(obj) && 'insertId' in obj && 'affectedRows' in obj;
 }
-async function importMysqlPoolFactory() {
-    try {
-        // The imported module name must be a string literal to make
-        // some bundlers work. So don't move this code behind a helper
-        // for example.
-        const mysqlModule = await Promise.resolve().then(() => require('mysql2'));
-        if ((0, object_utils_js_1.isFunction)(mysqlModule.createPool)) {
-            return mysqlModule.createPool;
-        }
-        else {
-            return mysqlModule.default.createPool;
-        }
-    }
-    catch (error) {
-        throw new Error('MySQL client not installed. Please run `npm install mysql2`');
-    }
-}
 class MysqlConnection {
     #rawConnection;
     constructor(rawConnection) {

package/dist/cjs/dialect/postgres/postgres-dialect-config.d.ts

@@ -1,103 +1,39 @@
-/// <reference types="node" />
-import * as stream from 'stream';
-import { ConnectionOptions } from 'tls';
 import { DatabaseConnection } from '../../driver/database-connection.js';
 /**
  * Config for the PostgreSQL dialect.
- *
- * This interface is equal to `pg` library's `Pool` config:
- *
- * https://node-postgres.com/api/pool
- * https://node-postgres.com/api/client
  */
 export interface PostgresDialectConfig {
     /**
-     * defaults process.env.PGUSER || process.env.USER.
-     */
-    user?: string;
-    /**
-     * default process.env.PGDATABASE || process.env.USER
-     */
-    database?: string;
-    /**
-     * default process.env.PGPASSWORD
-     */
-    password?: string | (() => string | Promise<string>);
-    /**
-     * default process.env.PGPORT
-     */
-    port?: number;
-    /**
-     * default process.env.PGHOST
-     */
-    host?: string;
-    /**
-     * e.g. postgres:*user:password@host:5432/database
-     */
-    connectionString?: string;
-    /**
-     * passed directly to node.TLSSocket, supports all tls.connect options
-     */
-    ssl?: boolean | ConnectionOptions;
-    /**
-     * Number of milliseconds to wait before timing out when connecting a new client
-     * by default this is 0 which means no timeout.
-     */
-    connectionTimeoutMillis?: number;
-    /**
-     * Maximum number of clients the pool should contain. by default this is set to 10.
-     */
-    max?: number;
-    /**
-     * Minimum number of clients the pool should contain
-     */
-    min?: number;
-    /**
-     * Number of milliseconds a client must sit idle in the pool and not be checked out
-     * before it is disconnected from the backend and discarded.
+     * A postgres Pool instance or a function that returns one.
      *
-     * default is 10000 (10 seconds) - set to 0 to disable auto-disconnection of idle clients.
-     */
-    idleTimeoutMillis?: number;
-    /**
-     * Default behavior is the pool will keep clients open & connected to the backend
-     * until idleTimeoutMillis expire for each client and node will maintain a ref
-     * to the socket on the client, keeping the event loop alive until all clients are closed
-     * after being idle or the pool is manually shutdown with `pool.end()`.
+     * If a function is provided, it's called once when the first query is executed.
      *
-     * Setting `allowExitOnIdle: true` in the config will allow the node event loop to exit
-     * as soon as all clients in the pool are idle, even if their socket is still open
-     * to the PostgreSQL server.  This can be handy in scripts & tests
-     * where you don't want to wait for your clients to go idle before your process exits.
-     */
-    allowExitOnIdle?: boolean;
-    log?: (...messages: any[]) => void;
-    /**
-     * Number of milliseconds before a statement in query will time out, default is no timeout.
+     * https://node-postgres.com/api/pool
      */
-    statement_timeout?: false | number;
-    /**
-     * Number of milliseconds before terminating any session with an open idle transaction.
-     * Default is no timeout.
-     */
-    idle_in_transaction_session_timeout?: number;
-    /**
-     * Number of milliseconds before a query call will timeout, default is no timeout.
-     */
-    query_timeout?: number;
-    /**
-     * The name of the application that created this Client instance.
-     */
-    application_name?: string;
+    pool: PostgresPool | (() => Promise<PostgresPool>);
     /**
      * Called once for each created connection.
-     *
-     * This is a Kysely specific feature and does not come from the `pg` module.
      */
     onCreateConnection?: (connection: DatabaseConnection) => Promise<void>;
-    keepAlive?: boolean;
-    keepAliveInitialDelayMillis?: number;
-    types?: any;
-    stream?: stream.Duplex;
-    parseInputDatesAsUTC?: boolean;
+}
+/**
+ * This interface is the subset of pg driver's `Pool` class that
+ * kysely needs.
+ *
+ * We don't use the type from `pg` here to not have a dependency to it.
+ *
+ * https://node-postgres.com/api/pool
+ */
+export interface PostgresPool {
+    connect(): Promise<PostgresPoolClient>;
+    end(): Promise<void>;
+}
+export interface PostgresPoolClient {
+    query<R>(sql: string, parameters: ReadonlyArray<unknown>): Promise<PostgresQueryResult<R>>;
+    release(): void;
+}
+export interface PostgresQueryResult<R> {
+    command: 'UPDATE' | 'DELETE' | 'INSERT' | 'SELECT';
+    rowCount: number;
+    rows: R[];
 }