kysely 0.16.3 → 0.16.7

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

@@ -1,13 +1,10 @@
-/// <reference types="node" />
-import * as stream from 'stream';
-import { ConnectionOptions } from 'tls';
 import { Driver } from '../../driver/driver.js';
 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 { DialectAdapter } from '../dialect-adapter.js';
-import { DatabaseConnection } from '../../driver/database-connection.js';
+import { PostgresDialectConfig } from './postgres-dialect-config.js';
 /**
  * PostgreSQL dialect that uses the [pg](https://node-postgres.com/) library.
  *
@@ -42,102 +39,3 @@ export declare class PostgresDialect implements Dialect {
      */
     createIntrospector(db: Kysely<any>): DatabaseIntrospector;
 }
-/**
- * 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.
-     *
-     * 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()`.
-     *
-     * 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.
-     */
-    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;
-    /**
-     * 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;
-}

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

@@ -3,6 +3,7 @@ import { PostgresDriver } from './postgres-driver.js';
 import { PostgresIntrospector } from './postgres-introspector.js';
 import { PostgresQueryCompiler } from './postgres-query-compiler.js';
 import { PostgresAdapter } from './postgres-adapter.js';
+import { freeze } from '../../util/object-utils.js';
 /**
  * PostgreSQL dialect that uses the [pg](https://node-postgres.com/) library.
  *
@@ -16,7 +17,7 @@ import { PostgresAdapter } from './postgres-adapter.js';
 export class PostgresDialect {
     #config;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     createDriver() {
         return new PostgresDriver(this.#config);

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

@@ -1,6 +1,6 @@
 import { DatabaseConnection } from '../../driver/database-connection.js';
 import { Driver, TransactionSettings } from '../../driver/driver.js';
-import { PostgresDialectConfig } from './postgres-dialect.js';
+import { PostgresDialectConfig } from './postgres-dialect-config.js';
 export declare class PostgresDriver implements Driver {
     #private;
     constructor(config: PostgresDialectConfig);

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

@@ -1,13 +1,13 @@
 /// <reference types="./postgres-driver.d.ts" />
 import { CompiledQuery } from '../../query-compiler/compiled-query.js';
-import { importNamedFunction } from '../../util/dynamic-import.js';
+import { isFunction, freeze } from '../../util/object-utils.js';
 const PRIVATE_RELEASE_METHOD = Symbol();
 export class PostgresDriver {
     #config;
     #connections = new WeakMap();
     #pool = null;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     async init() {
         // Import the `pg` module here instead at the top of the file
@@ -63,7 +63,16 @@ export class PostgresDriver {
 }
 async function importPgPool() {
     try {
-        return await importNamedFunction('pg', 'Pool');
+        // 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 pgModule = await import('pg');
+        if (isFunction(pgModule.Pool)) {
+            return pgModule.Pool;
+        }
+        else {
+            return pgModule.default.Pool;
+        }
     }
     catch (error) {
         throw new Error('Postgres client not installed. Please run `npm install pg`');

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

@@ -0,0 +1,43 @@
+import { DatabaseConnection } from '../../driver/database-connection.js';
+/**
+ * Config for the SQLite dialect.
+ *
+ * This interface is equal to `better-sqlite3` library's `Databse` class's constructor parameters.
+ *
+ * https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/api.md#new-databasepath-options
+ */
+export interface SqliteDialectConfig {
+    /**
+     * The database file path.
+     *
+     * This is passed as the first argument for the [Database](https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/api.md#new-databasepath-options)
+     * class constructor.
+     */
+    databasePath: string;
+    /**
+     * Open the database connection in readonly mode (default: false)
+     */
+    readonly?: boolean;
+    /**
+     * If the database does not exist, an Error will be thrown instead of creating a new file.
+     * This option is ignored for in-memory, temporary, or readonly database connections
+     * (default: false)
+     */
+    fileMustExist?: boolean;
+    /**
+     * The number of milliseconds to wait when executing queries on a locked database,
+     * before throwing a SQLITE_BUSY error (default: 5000)
+     */
+    timeout?: number;
+    /**
+     * Provide a function that gets called with every SQL string executed by the database connection
+     * (default: null)
+     */
+    verbose?: (sql: string) => void;
+    /**
+     * Called once when the first query is executed.
+     *
+     * This is a Kysely specific feature and does not come from the `better-sqlite3` module.
+     */
+    onCreateConnection?: (connection: DatabaseConnection) => Promise<void>;
+}

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

@@ -0,0 +1,2 @@
+/// <reference types="./sqlite-dialect-config.d.ts" />
+export {};

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

@@ -4,7 +4,7 @@ import { QueryCompiler } from '../../query-compiler/query-compiler.js';
 import { Dialect } from '../dialect.js';
 import { DatabaseIntrospector } from '../database-introspector.js';
 import { DialectAdapter } from '../dialect-adapter.js';
-import { DatabaseConnection } from '../../driver/database-connection.js';
+import { SqliteDialectConfig } from './sqlite-dialect-config.js';
 /**
  * SQLite dialect that uses the [better-sqlite3](https://github.com/JoshuaWise/better-sqlite3) library.
  *
@@ -36,45 +36,3 @@ export declare class SqliteDialect implements Dialect {
      */
     createIntrospector(db: Kysely<any>): DatabaseIntrospector;
 }
-/**
- * Config for the SQLite dialect.
- *
- * This interface is equal to `better-sqlite3` library's `Databse` class's constructor parameters.
- *
- * https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/api.md#new-databasepath-options
- */
-export interface SqliteDialectConfig {
-    /**
-     * The database file path.
-     *
-     * This is passed as the first argument for the [Database](https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/api.md#new-databasepath-options)
-     * class constructor.
-     */
-    databasePath: string;
-    /**
-     * Open the database connection in readonly mode (default: false)
-     */
-    readonly?: boolean;
-    /**
-     * If the database does not exist, an Error will be thrown instead of creating a new file.
-     * This option is ignored for in-memory, temporary, or readonly database connections
-     * (default: false)
-     */
-    fileMustExist?: boolean;
-    /**
-     * The number of milliseconds to wait when executing queries on a locked database,
-     * before throwing a SQLITE_BUSY error (default: 5000)
-     */
-    timeout?: number;
-    /**
-     * Provide a function that gets called with every SQL string executed by the database connection
-     * (default: null)
-     */
-    verbose?: (sql: string) => void;
-    /**
-     * Called once when the first query is executed.
-     *
-     * This is a Kysely specific feature and does not come from the `better-sqlite3` module.
-     */
-    onCreateConnection?: (connection: DatabaseConnection) => Promise<void>;
-}

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

@@ -3,6 +3,7 @@ import { SqliteDriver } from './sqlite-driver.js';
 import { SqliteQueryCompiler } from './sqlite-query-compiler.js';
 import { SqliteIntrospector } from './sqlite-introspector.js';
 import { SqliteAdapter } from './sqlite-adapter.js';
+import { freeze } from '../../util/object-utils.js';
 /**
  * SQLite dialect that uses the [better-sqlite3](https://github.com/JoshuaWise/better-sqlite3) library.
  *
@@ -13,7 +14,7 @@ import { SqliteAdapter } from './sqlite-adapter.js';
 export class SqliteDialect {
     #config;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     createDriver() {
         return new SqliteDriver(this.#config);

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

@@ -1,6 +1,6 @@
 import { DatabaseConnection } from '../../driver/database-connection.js';
 import { Driver } from '../../driver/driver.js';
-import { SqliteDialectConfig } from './sqlite-dialect.js';
+import { SqliteDialectConfig } from './sqlite-dialect-config.js';
 export declare class SqliteDriver implements Driver {
     #private;
     constructor(config: SqliteDialectConfig);

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

@@ -1,14 +1,13 @@
 /// <reference types="./sqlite-driver.d.ts" />
 import { CompiledQuery } from '../../query-compiler/compiled-query.js';
-import { importFunction } from '../../util/dynamic-import.js';
-import { isBoolean, isFunction, isNumber } from '../../util/object-utils.js';
+import { freeze, isBoolean, isFunction, isNumber, } from '../../util/object-utils.js';
 export class SqliteDriver {
     #config;
     #connectionMutex = new ConnectionMutex();
     #db;
     #connection;
     constructor(config) {
-        this.#config = config;
+        this.#config = freeze({ ...config });
     }
     async init() {
         // Import the `better-sqlite3` module here instead at the top of the file
@@ -60,7 +59,16 @@ export class SqliteDriver {
 }
 async function importBetterSqlite3Database() {
     try {
-        return await importFunction('better-sqlite3');
+        // 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 sqliteModule = await import('better-sqlite3');
+        if (isFunction(sqliteModule)) {
+            return sqliteModule;
+        }
+        else {
+            return sqliteModule.default;
+        }
     }
     catch (error) {
         throw new Error('SQLite client not installed. Please run `npm install better-sqlite3`');

package/dist/esm/driver/dummy-driver.d.ts

@@ -0,0 +1,68 @@
+import { DatabaseConnection } from './database-connection.js';
+import { Driver } from './driver.js';
+/**
+ * A driver that does absolutely nothing.
+ *
+ * You can use this to create Kysely instances solely for building queries
+ *
+ * ### Examples
+ *
+ * This example creates a Kysely instance for building postgres queries:
+ *
+ * ```ts
+ * const db = new Kysely<Database>({
+ *   dialect: {
+ *     createAdapter() {
+ *       return new PostgresAdapter()
+ *     },
+ *     createDriver() {
+ *       return new DummyDriver()
+ *     },
+ *     createIntrospector(db: Kysely<any>) {
+ *       return new PostgresIntrospector(db)
+ *     },
+ *     createQueryCompiler() {
+ *       return new PostgresQueryCompiler()
+ *     },
+ *   },
+ * })
+ * ```
+ */
+export declare class DummyDriver implements Driver {
+    /**
+     * Initializes the driver.
+     *
+     * After calling this method the driver should be usable and `acquireConnection` etc.
+     * methods should be callable.
+     *
+     * IMPORTANT: The underlying database engine driver (like [pg](https://node-postgres.com/))
+     * should be imported inside this function, not at the top of the driver file! This is
+     * important so that Kysely is usable without installing all database driver libraries
+     * it supports.
+     */
+    init(): Promise<void>;
+    /**
+     * Acquires a new connection from the pool.
+     */
+    acquireConnection(): Promise<DatabaseConnection>;
+    /**
+     * Begins a transaction.
+     */
+    beginTransaction(): Promise<void>;
+    /**
+     * Commits a transaction.
+     */
+    commitTransaction(): Promise<void>;
+    /**
+     * Rolls back a transaction.
+     */
+    rollbackTransaction(): Promise<void>;
+    /**
+     * Releases a connection back to the pool.
+     */
+    releaseConnection(): Promise<void>;
+    /**
+     * Destroys the driver and releases all resources.
+     */
+    destroy(): Promise<void>;
+}

package/dist/esm/driver/dummy-driver.js

@@ -0,0 +1,59 @@
+/// <reference types="./dummy-driver.d.ts" />
+/**
+ * A driver that does absolutely nothing.
+ *
+ * You can use this to create Kysely instances solely for building queries
+ *
+ * ### Examples
+ *
+ * This example creates a Kysely instance for building postgres queries:
+ *
+ * ```ts
+ * const db = new Kysely<Database>({
+ *   dialect: {
+ *     createAdapter() {
+ *       return new PostgresAdapter()
+ *     },
+ *     createDriver() {
+ *       return new DummyDriver()
+ *     },
+ *     createIntrospector(db: Kysely<any>) {
+ *       return new PostgresIntrospector(db)
+ *     },
+ *     createQueryCompiler() {
+ *       return new PostgresQueryCompiler()
+ *     },
+ *   },
+ * })
+ * ```
+ */
+export class DummyDriver {
+    async init() {
+        // Nothing to do here.
+    }
+    async acquireConnection() {
+        return new DummyConnection();
+    }
+    async beginTransaction() {
+        // Nothing to do here.
+    }
+    async commitTransaction() {
+        // Nothing to do here.
+    }
+    async rollbackTransaction() {
+        // Nothing to do here.
+    }
+    async releaseConnection() {
+        // Nothing to do here.
+    }
+    async destroy() {
+        // Nothing to do here.
+    }
+}
+class DummyConnection {
+    async executeQuery() {
+        return {
+            rows: [],
+        };
+    }
+}

package/dist/esm/driver/runtime-driver.d.ts

@@ -28,7 +28,7 @@ export declare class RuntimeDriver implements Driver {
     /**
      * Releases a connection back to the pool.
      */
-    releaseConnection(runtimeConnection: DatabaseConnection): Promise<void>;
+    releaseConnection(connection: DatabaseConnection): Promise<void>;
     /**
      * Begins a transaction.
      */

package/dist/esm/driver/runtime-driver.js

@@ -10,7 +10,7 @@ export class RuntimeDriver {
     #log;
     #initPromise;
     #destroyPromise;
-    #connections = new WeakMap();
+    #connections = new WeakSet();
     constructor(driver, log) {
         this.#driver = driver;
         this.#log = log;
@@ -27,17 +27,16 @@ export class RuntimeDriver {
     async acquireConnection() {
         await this.init();
         const connection = await this.#driver.acquireConnection();
-        let runtimeConnection = this.#connections.get(connection);
-        if (!runtimeConnection) {
-            runtimeConnection = new RuntimeConnection(connection, this.#log);
-            this.#connections.set(connection, runtimeConnection);
+        if (!this.#connections.has(connection)) {
+            if (this.#needsLogging()) {
+                this.#addLogging(connection);
+            }
+            this.#connections.add(connection);
         }
-        return runtimeConnection;
+        return connection;
     }
-    async releaseConnection(runtimeConnection) {
-        if (runtimeConnection instanceof RuntimeConnection) {
-            await this.#driver.releaseConnection(runtimeConnection.connection);
-        }
+    async releaseConnection(connection) {
+        await this.#driver.releaseConnection(connection);
     }
     beginTransaction(connection, settings) {
         return this.#driver.beginTransaction(connection, settings);
@@ -61,29 +60,27 @@ export class RuntimeDriver {
         }
         await this.#destroyPromise;
     }
-}
-class RuntimeConnection {
-    #connection;
-    #log;
-    get connection() {
-        return this.#connection;
-    }
-    constructor(connection, log) {
-        this.#connection = connection;
-        this.#log = log;
+    #needsLogging() {
+        return (this.#log.isLevelEnabled('query') || this.#log.isLevelEnabled('error'));
     }
-    async executeQuery(compiledQuery) {
-        const startTime = performanceNow();
-        try {
-            return await this.#connection.executeQuery(compiledQuery);
-        }
-        catch (error) {
-            this.#logError(error);
-            throw error;
-        }
-        finally {
-            this.#logQuery(compiledQuery, startTime);
-        }
+    // This method monkey patches the database connection's executeQuery method
+    // by adding logging code around it. Monkey patching is not pretty, but it's
+    // the best option in this case.
+    #addLogging(connection) {
+        const executeQuery = connection.executeQuery;
+        connection.executeQuery = async (compiledQuery) => {
+            const startTime = performanceNow();
+            try {
+                return await executeQuery.call(connection, compiledQuery);
+            }
+            catch (error) {
+                this.#logError(error);
+                throw error;
+            }
+            finally {
+                this.#logQuery(compiledQuery, startTime);
+            }
+        };
     }
     #logError(error) {
         this.#log.error(() => ({

package/dist/esm/index-nodeless.d.ts

@@ -40,6 +40,7 @@ export * from './driver/database-connection.js';
 export * from './driver/connection-provider.js';
 export * from './driver/default-connection-provider.js';
 export * from './driver/single-connection-provider.js';
+export * from './driver/dummy-driver.js';
 export * from './dialect/dialect.js';
 export * from './dialect/dialect-adapter.js';
 export * from './dialect/dialect-adapter-base.js';
@@ -58,6 +59,7 @@ export * from './query-compiler/query-compiler.js';
 export * from './migration/migrator.js';
 export * from './plugin/kysely-plugin.js';
 export * from './plugin/camel-case/camel-case-plugin.js';
+export * from './plugin/deduplicate-joins/deduplicate-joins-plugin.js';
 export * from './operation-node/add-column-node.js';
 export * from './operation-node/add-constraint-node.js';
 export * from './operation-node/alias-node.js';

package/dist/esm/index-nodeless.js

@@ -41,6 +41,7 @@ export * from './driver/database-connection.js';
 export * from './driver/connection-provider.js';
 export * from './driver/default-connection-provider.js';
 export * from './driver/single-connection-provider.js';
+export * from './driver/dummy-driver.js';
 export * from './dialect/dialect.js';
 export * from './dialect/dialect-adapter.js';
 export * from './dialect/dialect-adapter-base.js';
@@ -59,6 +60,7 @@ export * from './query-compiler/query-compiler.js';
 export * from './migration/migrator.js';
 export * from './plugin/kysely-plugin.js';
 export * from './plugin/camel-case/camel-case-plugin.js';
+export * from './plugin/deduplicate-joins/deduplicate-joins-plugin.js';
 export * from './operation-node/add-column-node.js';
 export * from './operation-node/add-constraint-node.js';
 export * from './operation-node/alias-node.js';

package/dist/esm/index.d.ts

@@ -1,8 +1,11 @@
 export * from './index-nodeless.js';
 export * from './migration/file-migration-provider.js';
 export * from './dialect/sqlite/sqlite-dialect.js';
+export * from './dialect/sqlite/sqlite-dialect-config.js';
 export * from './dialect/sqlite/sqlite-driver.js';
 export * from './dialect/mysql/mysql-dialect.js';
+export * from './dialect/mysql/mysql-dialect-config.js';
 export * from './dialect/mysql/mysql-driver.js';
 export * from './dialect/postgres/postgres-driver.js';
+export * from './dialect/postgres/postgres-dialect-config.js';
 export * from './dialect/postgres/postgres-dialect.js';

package/dist/esm/index.js

@@ -2,8 +2,11 @@
 export * from './index-nodeless.js';
 export * from './migration/file-migration-provider.js';
 export * from './dialect/sqlite/sqlite-dialect.js';
+export * from './dialect/sqlite/sqlite-dialect-config.js';
 export * from './dialect/sqlite/sqlite-driver.js';
 export * from './dialect/mysql/mysql-dialect.js';
+export * from './dialect/mysql/mysql-dialect-config.js';
 export * from './dialect/mysql/mysql-driver.js';
 export * from './dialect/postgres/postgres-driver.js';
+export * from './dialect/postgres/postgres-dialect-config.js';
 export * from './dialect/postgres/postgres-dialect.js';

package/dist/esm/kysely.d.ts

@@ -22,22 +22,24 @@ import { DialectAdapter } from './dialect/dialect-adapter.js';
  * This example assumes your database has tables `person` and `pet`:
  *
  * ```ts
- * interface Person {
- *   id: number
+ * import { Kysely, Generated, PostgresDialect } from 'kysely'
+ *
+ * interface PersonTable {
+ *   id: Generated<number>
  *   first_name: string
  *   last_name: string
  * }
  *
- * interface Pet {
- *   id: number
+ * interface PetTable {
+ *   id: Generated<number>
  *   owner_id: number
  *   name: string
  *   species 'cat' | 'dog'
  * }
  *
  * interface Database {
- *   person: Person,
- *   pet: Pet
+ *   person: PersonTable,
+ *   pet: PetTable
  * }
  *
  * const db = new Kysely<Database>({