kysely 0.18.0 → 0.18.1

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

@@ -1,24 +1,30 @@
 /// <reference types="./mysql-driver.d.ts" />
 import { CompiledQuery } from '../../query-compiler/compiled-query.js';
 import { isFunction, isObject, freeze } from '../../util/object-utils.js';
+import { extendStackTrace } from '../../util/stack-trace-utils.js';
 const PRIVATE_RELEASE_METHOD = Symbol();
 export class MysqlDriver {
     #config;
     #connections = new WeakMap();
     #pool;
-    constructor(config) {
-        this.#config = freeze({ ...config });
+    constructor(configOrPool) {
+        if (isMysqlPool(configOrPool)) {
+            this.#pool = configOrPool;
+        }
+        else {
+            this.#config = freeze({ ...configOrPool });
+        }
     }
     async init() {
-        // 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. As you can see, there IS an import from `mysql2` 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 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);
+        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);
+        }
     }
     async acquireConnection() {
         const rawConnection = await this.#acquireConnection();
@@ -29,7 +35,7 @@ export class MysqlDriver {
             // The driver must take care of calling `onCreateConnection` when a new
             // connection is created. The `mysql2` module doesn't provide an async hook
             // for the connection creation. We need to call the method explicitly.
-            if (this.#config.onCreateConnection) {
+            if (this.#config?.onCreateConnection) {
                 await this.#config.onCreateConnection(connection);
             }
         }
@@ -61,8 +67,7 @@ export class MysqlDriver {
         await connection.executeQuery(CompiledQuery.raw('rollback'));
     }
     async releaseConnection(connection) {
-        const mysqlConnection = connection;
-        mysqlConnection[PRIVATE_RELEASE_METHOD]();
+        connection[PRIVATE_RELEASE_METHOD]();
     }
     async destroy() {
         return new Promise((resolve, reject) => {
@@ -77,6 +82,12 @@ export class MysqlDriver {
         });
     }
 }
+function isMysqlPool(obj) {
+    return isObject(obj) && isFunction(obj.getConnection) && isFunction(obj.end);
+}
+function isOkPacket(obj) {
+    return isObject(obj) && 'insertId' in obj && 'affectedRows' in obj;
+}
 async function importMysqlPoolFactory() {
     try {
         // The imported module name must be a string literal to make
@@ -100,29 +111,34 @@ class MysqlConnection {
         this.#rawConnection = rawConnection;
     }
     async executeQuery(compiledQuery) {
-        const result = await this.#executeQuery(compiledQuery);
-        if (isOkPacket(result)) {
-            const { insertId, affectedRows } = result;
+        try {
+            const result = await this.#executeQuery(compiledQuery);
+            if (isOkPacket(result)) {
+                const { insertId, affectedRows } = result;
+                return {
+                    insertId: insertId !== undefined &&
+                        insertId !== null &&
+                        insertId.toString() !== '0'
+                        ? BigInt(insertId)
+                        : undefined,
+                    numUpdatedOrDeletedRows: affectedRows !== undefined && insertId !== null
+                        ? BigInt(affectedRows)
+                        : undefined,
+                    rows: [],
+                };
+            }
+            else if (Array.isArray(result)) {
+                return {
+                    rows: result,
+                };
+            }
             return {
-                insertId: insertId !== undefined &&
-                    insertId !== null &&
-                    insertId.toString() !== '0'
-                    ? BigInt(insertId)
-                    : undefined,
-                numUpdatedOrDeletedRows: affectedRows !== undefined && insertId !== null
-                    ? BigInt(affectedRows)
-                    : undefined,
                 rows: [],
             };
         }
-        else if (Array.isArray(result)) {
-            return {
-                rows: result,
-            };
+        catch (err) {
+            throw extendStackTrace(err, new Error());
         }
-        return {
-            rows: [],
-        };
     }
     #executeQuery(compiledQuery) {
         return new Promise((resolve, reject) => {
@@ -140,6 +156,3 @@ class MysqlConnection {
         this.#rawConnection.release();
     }
 }
-function isOkPacket(obj) {
-    return isObject(obj) && 'insertId' in obj && 'affectedRows' in obj;
-}

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

@@ -1,10 +1,20 @@
-import { DatabaseIntrospector, DatabaseMetadata, DatabaseMetadataOptions } from '../database-introspector.js';
+import { DatabaseIntrospector, DatabaseMetadata, DatabaseMetadataOptions, SchemaMetadata, TableMetadata } from '../database-introspector.js';
 import { Kysely } from '../../kysely.js';
 export declare class MysqlIntrospector implements DatabaseIntrospector {
     #private;
     constructor(db: Kysely<any>);
+    /**
+     * Get schema metadata.
+     */
+    getSchemas(): Promise<SchemaMetadata[]>;
+    /**
+     * Get table metadata.
+     */
+    getTables(options?: DatabaseMetadataOptions): Promise<TableMetadata[]>;
     /**
      * Get the database metadata such as table and column names.
+     *
+     * @deprecated Use getTables() instead.
      */
     getMetadata(options?: DatabaseMetadataOptions): Promise<DatabaseMetadata>;
 }

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

@@ -1,26 +1,47 @@
 /// <reference types="./mysql-introspector.d.ts" />
-import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migrator.js';
+import { DEFAULT_MIGRATION_LOCK_TABLE, DEFAULT_MIGRATION_TABLE, } from '../../migration/migrator.js';
 import { freeze } from '../../util/object-utils.js';
-import { sql } from '../../raw-builder/sql.js';
 export class MysqlIntrospector {
     #db;
     constructor(db) {
         this.#db = db;
     }
-    async getMetadata(options = { withInternalKyselyTables: false }) {
+    async getSchemas() {
+        let rawSchemas = await this.#db
+            .selectFrom('information_schema.schemata')
+            .select('schema_name')
+            .castTo()
+            .execute();
+        return rawSchemas.map((it) => ({ name: it.SCHEMA_NAME }));
+    }
+    async getTables(options = { withInternalKyselyTables: false }) {
         let query = this.#db
             .selectFrom('information_schema.columns')
-            .selectAll()
-            .where('table_schema', '=', sql `database()`)
+            .select([
+            'column_name',
+            'table_name',
+            'table_schema',
+            'is_nullable',
+            'data_type',
+        ])
+            .where('table_schema', 'not in', [
+            'information_schema',
+            'performance_schema',
+            'mysql',
+            'sys',
+        ])
             .castTo();
         if (!options.withInternalKyselyTables) {
             query = query
-                .where('table_name', '!=', MIGRATION_TABLE)
-                .where('table_name', '!=', MIGRATION_LOCK_TABLE);
+                .where('table_name', '!=', DEFAULT_MIGRATION_TABLE)
+                .where('table_name', '!=', DEFAULT_MIGRATION_LOCK_TABLE);
         }
         const rawColumns = await query.execute();
+        return this.#parseTableMetadata(rawColumns);
+    }
+    async getMetadata(options) {
         return {
-            tables: this.#parseTableMetadata(rawColumns),
+            tables: await this.getTables(options),
         };
     }
     #parseTableMetadata(columns) {
@@ -29,6 +50,7 @@ export class MysqlIntrospector {
             if (!table) {
                 table = freeze({
                     name: it.TABLE_NAME,
+                    schema: it.TABLE_SCHEMA,
                     columns: [],
                 });
                 tables.push(table);

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

@@ -2,6 +2,7 @@ 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';
@@ -14,10 +15,17 @@ import { PostgresDialectConfig } from './postgres-dialect-config.js';
  *
  * https://node-postgres.com/api/pool
  * https://node-postgres.com/api/client
+ *
+ * You can also provide an existing pg `Pool` instance:
+ *
+ * ```ts
+ * import { Pool } from 'pg'
+ * new PostgresDialect(new Pool(config))
+ * ```
  */
 export declare class PostgresDialect implements Dialect {
     #private;
-    constructor(config: PostgresDialectConfig);
+    constructor(configOrPool: PostgresDialectConfig | PostgresPool);
     /**
      * Creates a driver for the dialect.
      */

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

@@ -3,7 +3,6 @@ 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.
  *
@@ -13,14 +12,21 @@ import { freeze } from '../../util/object-utils.js';
  *
  * https://node-postgres.com/api/pool
  * https://node-postgres.com/api/client
+ *
+ * You can also provide an existing pg `Pool` instance:
+ *
+ * ```ts
+ * import { Pool } from 'pg'
+ * new PostgresDialect(new Pool(config))
+ * ```
  */
 export class PostgresDialect {
-    #config;
-    constructor(config) {
-        this.#config = freeze({ ...config });
+    #configOrPool;
+    constructor(configOrPool) {
+        this.#configOrPool = configOrPool;
     }
     createDriver() {
-        return new PostgresDriver(this.#config);
+        return new PostgresDriver(this.#configOrPool);
     }
     createQueryCompiler() {
         return new PostgresQueryCompiler();

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

@@ -1,9 +1,11 @@
-import { DatabaseConnection } from '../../driver/database-connection.js';
+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';
+declare const PRIVATE_RELEASE_METHOD: unique symbol;
 export declare class PostgresDriver implements Driver {
     #private;
-    constructor(config: PostgresDialectConfig);
+    constructor(configOrPool: PostgresDialectConfig | PostgresPool);
     /**
      * Initializes the driver.
      *
@@ -35,9 +37,29 @@ export declare class PostgresDriver implements Driver {
     /**
      * Releases a connection back to the pool.
      */
-    releaseConnection(connection: DatabaseConnection): Promise<void>;
+    releaseConnection(connection: PostgresConnection): Promise<void>;
     /**
      * Destroys the driver and releases all resources.
      */
     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);
+    executeQuery<O>(compiledQuery: CompiledQuery): Promise<QueryResult<O>>;
+    [PRIVATE_RELEASE_METHOD](): void;
+}
+export {};

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

@@ -1,24 +1,30 @@
 /// <reference types="./postgres-driver.d.ts" />
 import { CompiledQuery } from '../../query-compiler/compiled-query.js';
-import { isFunction, freeze } from '../../util/object-utils.js';
+import { isFunction, freeze, isObject } from '../../util/object-utils.js';
+import { extendStackTrace } from '../../util/stack-trace-utils.js';
 const PRIVATE_RELEASE_METHOD = Symbol();
 export class PostgresDriver {
     #config;
     #connections = new WeakMap();
-    #pool = null;
-    constructor(config) {
-        this.#config = freeze({ ...config });
+    #pool;
+    constructor(configOrPool) {
+        if (isPostgresPool(configOrPool)) {
+            this.#pool = configOrPool;
+        }
+        else {
+            this.#config = freeze({ ...configOrPool });
+        }
     }
     async init() {
-        // 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. As you can see, there IS an import from `pg` 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 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);
+        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);
+        }
     }
     async acquireConnection() {
         const client = await this.#pool.connect();
@@ -29,7 +35,7 @@ export class PostgresDriver {
             // The driver must take care of calling `onCreateConnection` when a new
             // connection is created. The `pg` module doesn't provide an async hook
             // for the connection creation. We need to call the method explicitly.
-            if (this.#config.onCreateConnection) {
+            if (this.#config?.onCreateConnection) {
                 await this.#config.onCreateConnection(connection);
             }
         }
@@ -50,17 +56,19 @@ export class PostgresDriver {
         await connection.executeQuery(CompiledQuery.raw('rollback'));
     }
     async releaseConnection(connection) {
-        const pgConnection = connection;
-        pgConnection[PRIVATE_RELEASE_METHOD]();
+        connection[PRIVATE_RELEASE_METHOD]();
     }
     async destroy() {
         if (this.#pool) {
             const pool = this.#pool;
-            this.#pool = null;
+            this.#pool = undefined;
             await pool.end();
         }
     }
 }
+function isPostgresPool(obj) {
+    return isObject(obj) && isFunction(obj.connect) && isFunction(obj.end);
+}
 async function importPgPool() {
     try {
         // The imported module name must be a string literal to make
@@ -84,18 +92,23 @@ class PostgresConnection {
         this.#client = client;
     }
     async executeQuery(compiledQuery) {
-        const result = await this.#client.query(compiledQuery.sql, [
-            ...compiledQuery.parameters,
-        ]);
-        if (result.command === 'UPDATE' || result.command === 'DELETE') {
+        try {
+            const result = await this.#client.query(compiledQuery.sql, [
+                ...compiledQuery.parameters,
+            ]);
+            if (result.command === 'UPDATE' || result.command === 'DELETE') {
+                return {
+                    numUpdatedOrDeletedRows: BigInt(result.rowCount),
+                    rows: result.rows ?? [],
+                };
+            }
             return {
-                numUpdatedOrDeletedRows: BigInt(result.rowCount),
                 rows: result.rows ?? [],
             };
         }
-        return {
-            rows: result.rows ?? [],
-        };
+        catch (err) {
+            throw extendStackTrace(err, new Error());
+        }
     }
     [PRIVATE_RELEASE_METHOD]() {
         this.#client.release();

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

@@ -1,10 +1,20 @@
-import { DatabaseIntrospector, DatabaseMetadata, DatabaseMetadataOptions } from '../database-introspector.js';
+import { DatabaseIntrospector, DatabaseMetadata, DatabaseMetadataOptions, SchemaMetadata, TableMetadata } from '../database-introspector.js';
 import { Kysely } from '../../kysely.js';
 export declare class PostgresIntrospector implements DatabaseIntrospector {
     #private;
     constructor(db: Kysely<any>);
+    /**
+     * Get schema metadata.
+     */
+    getSchemas(): Promise<SchemaMetadata[]>;
+    /**
+     * Get table metadata.
+     */
+    getTables(options?: DatabaseMetadataOptions): Promise<TableMetadata[]>;
     /**
      * Get the database metadata such as table and column names.
+     *
+     * @deprecated Use getTables() instead.
      */
     getMetadata(options?: DatabaseMetadataOptions): Promise<DatabaseMetadata>;
 }

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

@@ -1,12 +1,20 @@
 /// <reference types="./postgres-introspector.d.ts" />
-import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migrator.js';
+import { DEFAULT_MIGRATION_LOCK_TABLE, DEFAULT_MIGRATION_TABLE, } from '../../migration/migrator.js';
 import { freeze } from '../../util/object-utils.js';
 export class PostgresIntrospector {
     #db;
     constructor(db) {
         this.#db = db;
     }
-    async getMetadata(options = { withInternalKyselyTables: false }) {
+    async getSchemas() {
+        let rawSchemas = await this.#db
+            .selectFrom('pg_catalog.pg_namespace')
+            .select('nspname')
+            .castTo()
+            .execute();
+        return rawSchemas.map((it) => ({ name: it.nspname }));
+    }
+    async getTables(options = { withInternalKyselyTables: false }) {
         let query = this.#db
             .selectFrom('pg_catalog.pg_attribute as a')
             .innerJoin('pg_catalog.pg_class as c', 'a.attrelid', 'c.oid')
@@ -26,12 +34,15 @@ export class PostgresIntrospector {
             .castTo();
         if (!options.withInternalKyselyTables) {
             query = query
-                .where('t.tablename', '!=', MIGRATION_TABLE)
-                .where('t.tablename', '!=', MIGRATION_LOCK_TABLE);
+                .where('t.tablename', '!=', DEFAULT_MIGRATION_TABLE)
+                .where('t.tablename', '!=', DEFAULT_MIGRATION_LOCK_TABLE);
         }
         const rawColumns = await query.execute();
+        return this.#parseTableMetadata(rawColumns);
+    }
+    async getMetadata(options) {
         return {
-            tables: this.#parseTableMetadata(rawColumns),
+            tables: await this.getTables(options),
         };
     }
     #parseTableMetadata(columns) {

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

@@ -1,10 +1,20 @@
-import { DatabaseIntrospector, DatabaseMetadata, DatabaseMetadataOptions } from '../database-introspector.js';
+import { DatabaseIntrospector, DatabaseMetadata, DatabaseMetadataOptions, SchemaMetadata, TableMetadata } from '../database-introspector.js';
 import { Kysely } from '../../kysely.js';
 export declare class SqliteIntrospector implements DatabaseIntrospector {
     #private;
     constructor(db: Kysely<any>);
+    /**
+     * Get schema metadata.
+     */
+    getSchemas(): Promise<SchemaMetadata[]>;
+    /**
+     * Get table metadata.
+     */
+    getTables(options?: DatabaseMetadataOptions): Promise<TableMetadata[]>;
     /**
      * Get the database metadata such as table and column names.
+     *
+     * @deprecated Use getTables() instead.
      */
     getMetadata(options?: DatabaseMetadataOptions): Promise<DatabaseMetadata>;
 }

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

@@ -1,12 +1,16 @@
 /// <reference types="./sqlite-introspector.d.ts" />
-import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migrator.js';
+import { DEFAULT_MIGRATION_LOCK_TABLE, DEFAULT_MIGRATION_TABLE, } from '../../migration/migrator.js';
 import { sql } from '../../raw-builder/sql.js';
 export class SqliteIntrospector {
     #db;
     constructor(db) {
         this.#db = db;
     }
-    async getMetadata(options = { withInternalKyselyTables: false }) {
+    async getSchemas() {
+        // Sqlite doesn't support schemas.
+        return [];
+    }
+    async getTables(options = { withInternalKyselyTables: false }) {
         let query = this.#db
             .selectFrom('sqlite_schema')
             .where('type', '=', 'table')
@@ -15,12 +19,15 @@ export class SqliteIntrospector {
             .castTo();
         if (!options.withInternalKyselyTables) {
             query = query
-                .where('name', '!=', MIGRATION_TABLE)
-                .where('name', '!=', MIGRATION_LOCK_TABLE);
+                .where('name', '!=', DEFAULT_MIGRATION_TABLE)
+                .where('name', '!=', DEFAULT_MIGRATION_LOCK_TABLE);
         }
         const tables = await query.execute();
+        return Promise.all(tables.map(({ name }) => this.#getTableMetadata(name)));
+    }
+    async getMetadata(options) {
         return {
-            tables: await Promise.all(tables.map(({ name }) => this.#getTableMetadata(name))),
+            tables: await this.getTables(options),
         };
     }
     async #getTableMetadata(table) {

package/dist/esm/migration/migrator.d.ts

@@ -1,6 +1,6 @@
 import { Kysely } from '../kysely.js';
-export declare const MIGRATION_TABLE = "kysely_migration";
-export declare const MIGRATION_LOCK_TABLE = "kysely_migration_lock";
+export declare const DEFAULT_MIGRATION_TABLE = "kysely_migration";
+export declare const DEFAULT_MIGRATION_LOCK_TABLE = "kysely_migration_lock";
 export declare const MIGRATION_LOCK_ID = "migration_lock";
 export declare const NO_MIGRATIONS: NoMigrations;
 export interface Migration {
@@ -148,6 +148,48 @@ export declare class Migrator {
 export interface MigratorProps {
     readonly db: Kysely<any>;
     readonly provider: MigrationProvider;
+    /**
+     * The name of the internal migration table. Defaults to `kysely_migration`.
+     *
+     * If you do specify this, you need to ALWAYS use the same value. Kysely doesn't
+     * support changing the table on the fly. If you run the migrator even once with a
+     * table name X and then change the table name to Y, kysely will create a new empty
+     * migration table and attempt to run the migrations again, which will obviously
+     * fail.
+     *
+     * If you do specify this, ALWAYS ALWAYS use the same value from the beginning of
+     * the project, to the end of time or prepare to manually migrate the migration
+     * tables.
+     */
+    readonly migrationTableName?: string;
+    /**
+     * The name of the internal migration lock table. Defaults to `kysely_migration_lock`.
+     *
+     * If you do specify this, you need to ALWAYS use the same value. Kysely doesn't
+     * support changing the table on the fly. If you run the migrator even once with a
+     * table name X and then change the table name to Y, kysely will create a new empty
+     * lock table.
+     *
+     * If you do specify this, ALWAYS ALWAYS use the same value from the beginning of
+     * the project, to the end of time or prepare to manually migrate the migration
+     * tables.
+     */
+    readonly migrationLockTableName?: string;
+    /**
+     * The schema of the internal migration tables. Defaults to the default schema
+     * on dialects that support schemas.
+     *
+     * If you do specify this, you need to ALWAYS use the same value. Kysely doesn't
+     * support changing the schema on the fly. If you run the migrator even once with a
+     * schema name X and then change the schema name to Y, kysely will create a new empty
+     * migration tables in the new schema and attempt to run the migrations again, which
+     * will obviously fail.
+     *
+     * If you do specify this, ALWAYS ALWAYS use the same value from the beginning of
+     * the project, to the end of time or prepare to manually migrate the migration
+     * tables.
+     */
+    readonly migrationTableSchema?: string;
 }
 /**
  * All migration methods ({@link Migrator.migrateTo | migrateTo},