kysely 0.18.1 → 0.19.0

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

@@ -2,30 +2,42 @@ 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 { PostgresPool } from './postgres-driver.js';
 import { DatabaseIntrospector } from '../database-introspector.js';
 import { DialectAdapter } from '../dialect-adapter.js';
 import { PostgresDialectConfig } from './postgres-dialect-config.js';
 /**
  * PostgreSQL dialect that uses the [pg](https://node-postgres.com/) library.
  *
- * The {@link PostgresDialectConfig | configuration} passed to the constructor
- * is given as-is to the pg library's [Pool](https://node-postgres.com/api/pool)
- * constructor. See the following two links for more documentation:
+ * The constructor takes an instance of {@link PostgresDialectConfig}.
  *
- * https://node-postgres.com/api/pool
- * https://node-postgres.com/api/client
+ * ```ts
+ * import { Pool } from 'pg'
  *
- * You can also provide an existing pg `Pool` instance:
+ * new PostgresDialect({
+ *   pool: new Pool({
+ *     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 { Pool } from 'pg'
- * new PostgresDialect(new Pool(config))
+ *
+ * new PostgresDialect({
+ *   pool: async () => new Pool({
+ *     database: 'some_db',
+ *     host: 'localhost',
+ *   })
+ * })
  * ```
  */
 export declare class PostgresDialect implements Dialect {
     #private;
-    constructor(configOrPool: PostgresDialectConfig | PostgresPool);
+    constructor(config: PostgresDialectConfig);
     /**
      * Creates a driver for the dialect.
      */

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

@@ -8,27 +8,40 @@ const postgres_adapter_js_1 = require("./postgres-adapter.js");
 /**
  * PostgreSQL dialect that uses the [pg](https://node-postgres.com/) library.
  *
- * The {@link PostgresDialectConfig | configuration} passed to the constructor
- * is given as-is to the pg library's [Pool](https://node-postgres.com/api/pool)
- * constructor. See the following two links for more documentation:
+ * The constructor takes an instance of {@link PostgresDialectConfig}.
  *
- * https://node-postgres.com/api/pool
- * https://node-postgres.com/api/client
+ * ```ts
+ * import { Pool } from 'pg'
  *
- * You can also provide an existing pg `Pool` instance:
+ * new PostgresDialect({
+ *   pool: new Pool({
+ *     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 { Pool } from 'pg'
- * new PostgresDialect(new Pool(config))
+ *
+ * new PostgresDialect({
+ *   pool: async () => new Pool({
+ *     database: 'some_db',
+ *     host: 'localhost',
+ *   })
+ * })
  * ```
  */
 class PostgresDialect {
-    #configOrPool;
-    constructor(configOrPool) {
-        this.#configOrPool = configOrPool;
+    #config;
+    constructor(config) {
+        this.#config = config;
     }
     createDriver() {
-        return new postgres_driver_js_1.PostgresDriver(this.#configOrPool);
+        return new postgres_driver_js_1.PostgresDriver(this.#config);
     }
     createQueryCompiler() {
         return new postgres_query_compiler_js_1.PostgresQueryCompiler();

package/dist/cjs/dialect/postgres/postgres-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 { PostgresDialectConfig } from './postgres-dialect-config.js';
+import { PostgresDialectConfig, PostgresPoolClient } from './postgres-dialect-config.js';
 declare const PRIVATE_RELEASE_METHOD: unique symbol;
 export declare class PostgresDriver implements Driver {
     #private;
-    constructor(configOrPool: PostgresDialectConfig | PostgresPool);
+    constructor(config: PostgresDialectConfig);
     /**
      * Initializes the driver.
      *
@@ -43,19 +43,6 @@ export declare class PostgresDriver implements Driver {
      */
     destroy(): Promise<void>;
 }
-export interface PostgresPool {
-    connect(): Promise<PostgresPoolClient>;
-    end(): Promise<void>;
-}
-interface PostgresPoolClient {
-    query<R>(sql: string, parameters: ReadonlyArray<unknown>): Promise<PostgresQueryResult<R>>;
-    release(): void;
-}
-interface PostgresQueryResult<R> {
-    command: 'UPDATE' | 'DELETE' | 'INSERT' | 'SELECT';
-    rowCount: number;
-    rows: R[];
-}
 declare class PostgresConnection implements DatabaseConnection {
     #private;
     constructor(client: PostgresPoolClient);

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

@@ -9,24 +9,13 @@ class PostgresDriver {
     #config;
     #connections = new WeakMap();
     #pool;
-    constructor(configOrPool) {
-        if (isPostgresPool(configOrPool)) {
-            this.#pool = configOrPool;
-        }
-        else {
-            this.#config = (0, object_utils_js_1.freeze)({ ...configOrPool });
-        }
+    constructor(config) {
+        this.#config = (0, object_utils_js_1.freeze)({ ...config });
     }
     async init() {
-        if (this.#config) {
-            // Import the `pg` module here instead at the top of the file
-            // so that this file can be loaded by node without `pg` driver
-            // installed.
-            const PoolConstructor = await importPgPool();
-            // Use the `pg` module's own pool. All drivers should use the
-            // pool provided by the database library if possible.
-            this.#pool = new PoolConstructor(this.#config);
-        }
+        this.#pool = (0, object_utils_js_1.isFunction)(this.#config.pool)
+            ? await this.#config.pool()
+            : this.#config.pool;
     }
     async acquireConnection() {
         const client = await this.#pool.connect();
@@ -69,26 +58,6 @@ class PostgresDriver {
     }
 }
 exports.PostgresDriver = PostgresDriver;
-function isPostgresPool(obj) {
-    return (0, object_utils_js_1.isObject)(obj) && (0, object_utils_js_1.isFunction)(obj.connect) && (0, object_utils_js_1.isFunction)(obj.end);
-}
-async function importPgPool() {
-    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 pgModule = await Promise.resolve().then(() => require('pg'));
-        if ((0, object_utils_js_1.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`');
-    }
-}
 class PostgresConnection {
     #client;
     constructor(client) {

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

@@ -1,39 +1,16 @@
 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.
+     * An sqlite Database instance or a function that returns one.
      *
-     * 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)
+     * If a function is provided, it's called once when the first query is executed.
+     *
+     * https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/api.md#new-databasepath-options
      */
-    verbose?: (sql: string) => void;
+    database: SqliteDatabase | (() => Promise<SqliteDatabase>);
     /**
      * Called once when the first query is executed.
      *
@@ -41,3 +18,23 @@ export interface SqliteDialectConfig {
      */
     onCreateConnection?: (connection: DatabaseConnection) => Promise<void>;
 }
+/**
+ * This interface is the subset of better-sqlite3 driver's `Database` class that
+ * kysely needs.
+ *
+ * We don't use the type from `better-sqlite3` here to not have a dependency to it.
+ *
+ * https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/api.md#new-databasepath-options
+ */
+export interface SqliteDatabase {
+    close(): void;
+    prepare(sql: string): SqliteStatement;
+}
+export interface SqliteStatement {
+    readonly reader: boolean;
+    all(parameters: ReadonlyArray<unknown>): unknown[];
+    run(parameters: ReadonlyArray<unknown>): {
+        changes: number | bigint;
+        lastInsertRowid: number | bigint;
+    };
+}

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

@@ -8,9 +8,25 @@ import { SqliteDialectConfig } from './sqlite-dialect-config.js';
 /**
  * SQLite dialect that uses the [better-sqlite3](https://github.com/JoshuaWise/better-sqlite3) library.
  *
- * The {@link SqliteDialectConfig | configuration} is used to construct an instance of
- * [Database](https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/api.md#new-databasepath-options)
- * class. The configuration values are passed directly to the `Database` constructor.
+ * The constructor takes an instance of {@link SqliteDialectConfig}.
+ *
+ * ```ts
+ * import Database from 'better-sqlite3'
+ *
+ * new SqliteDialect({
+ *   database: new Database('db.sqlite')
+ * })
+ * ```
+ *
+ * If you want the pool to only be created once it's first used, `database`
+ * can be a function:
+ *
+ * ```ts
+ * import Database from 'better-sqlite3'
+ *
+ * new SqliteDialect({
+ *   database: async () => new Database('db.sqlite')
+ * })
  */
 export declare class SqliteDialect implements Dialect {
     #private;

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

@@ -9,9 +9,25 @@ const object_utils_js_1 = require("../../util/object-utils.js");
 /**
  * SQLite dialect that uses the [better-sqlite3](https://github.com/JoshuaWise/better-sqlite3) library.
  *
- * The {@link SqliteDialectConfig | configuration} is used to construct an instance of
- * [Database](https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/api.md#new-databasepath-options)
- * class. The configuration values are passed directly to the `Database` constructor.
+ * The constructor takes an instance of {@link SqliteDialectConfig}.
+ *
+ * ```ts
+ * import Database from 'better-sqlite3'
+ *
+ * new SqliteDialect({
+ *   database: new Database('db.sqlite')
+ * })
+ * ```
+ *
+ * If you want the pool to only be created once it's first used, `database`
+ * can be a function:
+ *
+ * ```ts
+ * import Database from 'better-sqlite3'
+ *
+ * new SqliteDialect({
+ *   database: async () => new Database('db.sqlite')
+ * })
  */
 class SqliteDialect {
     #config;

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

@@ -12,26 +12,9 @@ class SqliteDriver {
         this.#config = (0, object_utils_js_1.freeze)({ ...config });
     }
     async init() {
-        // Import the `better-sqlite3` module here instead at the top of the file
-        // so that this file can be loaded by node without `better-sqlite3` driver
-        // installed. As you can see, there IS an import from `better-sqlite3` at
-        // the top level too, but that's only for types. It doesn't get compiled
-        // into javascript. You can check the built javascript code.
-        const DatabaseConstructor = await importBetterSqlite3Database();
-        const options = {};
-        if ((0, object_utils_js_1.isBoolean)(this.#config.readonly)) {
-            options.readonly = this.#config.readonly;
-        }
-        if ((0, object_utils_js_1.isBoolean)(this.#config.fileMustExist)) {
-            options.fileMustExist = this.#config.fileMustExist;
-        }
-        if ((0, object_utils_js_1.isNumber)(this.#config.timeout)) {
-            options.timeout = this.#config.timeout;
-        }
-        if ((0, object_utils_js_1.isFunction)(this.#config.verbose)) {
-            options.verbose = this.#config.verbose;
-        }
-        this.#db = new DatabaseConstructor(this.#config.databasePath, options);
+        this.#db = (0, object_utils_js_1.isFunction)(this.#config.database)
+            ? await this.#config.database()
+            : this.#config.database;
         this.#connection = new SqliteConnection(this.#db);
         if (this.#config.onCreateConnection) {
             await this.#config.onCreateConnection(this.#connection);
@@ -60,23 +43,6 @@ class SqliteDriver {
     }
 }
 exports.SqliteDriver = SqliteDriver;
-async function importBetterSqlite3Database() {
-    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 sqliteModule = await Promise.resolve().then(() => require('better-sqlite3'));
-        if ((0, object_utils_js_1.isFunction)(sqliteModule)) {
-            return sqliteModule;
-        }
-        else {
-            return sqliteModule.default;
-        }
-    }
-    catch (error) {
-        throw new Error('SQLite client not installed. Please run `npm install better-sqlite3`');
-    }
-}
 class SqliteConnection {
     #db;
     constructor(db) {

package/dist/cjs/index.d.ts

@@ -1,11 +1,162 @@
-export * from './index-nodeless.js';
-export * from './migration/file-migration-provider.js';
+export * from './kysely.js';
+export * from './query-creator.js';
+export * from './query-builder/where-interface.js';
+export * from './query-builder/join-interface.js';
+export * from './query-builder/returning-interface.js';
+export * from './query-builder/having-interface.js';
+export * from './query-builder/select-query-builder.js';
+export * from './query-builder/insert-query-builder.js';
+export * from './query-builder/update-query-builder.js';
+export * from './query-builder/delete-query-builder.js';
+export * from './query-builder/no-result-error.js';
+export * from './query-builder/join-builder.js';
+export * from './query-builder/expression-builder.js';
+export * from './query-builder/function-builder.js';
+export * from './query-builder/insert-result.js';
+export * from './query-builder/delete-result.js';
+export * from './query-builder/update-result.js';
+export * from './query-builder/on-conflict-builder.js';
+export * from './raw-builder/raw-builder.js';
+export * from './raw-builder/sql.js';
+export * from './query-executor/query-executor.js';
+export * from './query-executor/default-query-executor.js';
+export * from './query-executor/noop-query-executor.js';
+export * from './query-executor/query-executor-provider.js';
+export * from './query-compiler/default-query-compiler.js';
+export * from './query-compiler/compiled-query.js';
+export * from './schema/schema.js';
+export * from './schema/create-table-builder.js';
+export * from './schema/drop-table-builder.js';
+export * from './schema/create-index-builder.js';
+export * from './schema/drop-index-builder.js';
+export * from './schema/create-schema-builder.js';
+export * from './schema/drop-schema-builder.js';
+export * from './schema/column-definition-builder.js';
+export * from './schema/foreign-key-constraint-builder.js';
+export * from './schema/alter-table-builder.js';
+export * from './schema/create-view-builder.js';
+export * from './schema/drop-view-builder.js';
+export * from './dynamic/dynamic.js';
+export * from './driver/driver.js';
+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';
+export * from './dialect/database-introspector.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/postgres/postgres-query-compiler.js';
+export * from './dialect/postgres/postgres-introspector.js';
+export * from './dialect/postgres/postgres-adapter.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/mysql/mysql-query-compiler.js';
+export * from './dialect/mysql/mysql-introspector.js';
+export * from './dialect/mysql/mysql-adapter.js';
 export * from './dialect/postgres/postgres-driver.js';
 export * from './dialect/postgres/postgres-dialect-config.js';
 export * from './dialect/postgres/postgres-dialect.js';
+export * from './dialect/sqlite/sqlite-query-compiler.js';
+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/migrator.js';
+export * from './migration/file-migration-provider.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';
+export * from './operation-node/alter-column-node.js';
+export * from './operation-node/alter-table-node.js';
+export * from './operation-node/and-node.js';
+export * from './operation-node/check-constraint-node.js';
+export * from './operation-node/column-definition-node.js';
+export * from './operation-node/column-node.js';
+export * from './operation-node/column-update-node.js';
+export * from './operation-node/common-table-expression-node.js';
+export * from './operation-node/common-table-expression-name-node.js';
+export * from './operation-node/constraint-node.js';
+export * from './operation-node/create-index-node.js';
+export * from './operation-node/create-schema-node.js';
+export * from './operation-node/create-table-node.js';
+export * from './operation-node/create-view-node.js';
+export * from './operation-node/data-type-node.js';
+export * from './operation-node/default-value-node.js';
+export * from './operation-node/delete-query-node.js';
+export * from './operation-node/drop-column-node.js';
+export * from './operation-node/drop-constraint-node.js';
+export * from './operation-node/drop-index-node.js';
+export * from './operation-node/drop-schema-node.js';
+export * from './operation-node/drop-table-node.js';
+export * from './operation-node/drop-view-node.js';
+export * from './operation-node/filter-node.js';
+export * from './operation-node/foreign-key-constraint-node.js';
+export * from './operation-node/from-node.js';
+export * from './operation-node/generated-node.js';
+export * from './operation-node/group-by-item-node.js';
+export * from './operation-node/group-by-node.js';
+export * from './operation-node/having-node.js';
+export * from './operation-node/identifier-node.js';
+export * from './operation-node/insert-query-node.js';
+export * from './operation-node/join-node.js';
+export * from './operation-node/limit-node.js';
+export * from './operation-node/list-node.js';
+export * from './operation-node/modify-column-node.js';
+export * from './operation-node/offset-node.js';
+export * from './operation-node/on-conflict-node.js';
+export * from './operation-node/on-duplicate-key-node.js';
+export * from './operation-node/on-node.js';
+export * from './operation-node/operation-node-source.js';
+export * from './operation-node/operation-node-transformer.js';
+export * from './operation-node/operation-node-utils.js';
+export * from './operation-node/operation-node-visitor.js';
+export * from './operation-node/operation-node.js';
+export * from './operation-node/operator-node.js';
+export * from './operation-node/or-node.js';
+export * from './operation-node/order-by-item-node.js';
+export * from './operation-node/order-by-node.js';
+export * from './operation-node/parens-node.js';
+export * from './operation-node/primary-constraint-node.js';
+export * from './operation-node/primitive-value-list-node.js';
+export * from './operation-node/query-node.js';
+export * from './operation-node/raw-node.js';
+export * from './operation-node/reference-node.js';
+export * from './operation-node/references-node.js';
+export * from './operation-node/rename-column-node.js';
+export * from './operation-node/returning-node.js';
+export * from './operation-node/select-all-node.js';
+export * from './operation-node/select-query-node.js';
+export * from './operation-node/select-query-node.js';
+export * from './operation-node/selection-node.js';
+export * from './operation-node/table-node.js';
+export * from './operation-node/union-node.js';
+export * from './operation-node/unique-constraint-node.js';
+export * from './operation-node/update-query-node.js';
+export * from './operation-node/value-list-node.js';
+export * from './operation-node/value-node.js';
+export * from './operation-node/values-node.js';
+export * from './operation-node/where-node.js';
+export * from './operation-node/with-node.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';
+export { SelectExpression, SelectExpressionOrList, Selection, } from './parser/select-parser.js';
+export { ReferenceExpression, ReferenceExpressionOrList, } from './parser/reference-parser.js';
+export { ValueExpression, ValueExpressionOrList, } from './parser/value-parser.js';
+export { FilterValueExpression, FilterValueExpressionOrList, ExistsExpression, FilterOperator, } from './parser/filter-parser.js';
+export { TableExpression, TableExpressionOrList, } from './parser/table-parser.js';
+export { JoinReferenceExpression, JoinCallbackExpression, } from './parser/join-parser.js';
+export { InsertObject } from './parser/insert-values-parser.js';
+export { MutationObject } from './parser/update-set-parser.js';
+export { OrderByExpression, OrderByDirectionExpression, } from './parser/order-by-parser.js';
+export { UnionExpression } from './parser/union-parser.js';