kysely 0.16.11 → 0.17.2

package/dist/cjs/schema/column-definition-builder.d.ts

@@ -83,15 +83,18 @@ export interface ColumnDefinitionBuilderInterface {
      *   .execute()
      * ```
      *
-     * Raw expressions are also supported:
+     * Values passed to `defaultTo` are interpreted as value literals by default. You can define
+     * an arbitrary SQL expression using the {@link sql} template tag:
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * db.schema
      *   .createTable('pet')
      *   .addColumn(
      *     'number_of_legs',
      *     'integer',
-     *     (col) => col.defaultTo(db.raw('any SQL here'))
+     *     (col) => col.defaultTo(sql`any SQL here`)
      *   )
      *   .execute()
      * ```
@@ -103,10 +106,12 @@ export interface ColumnDefinitionBuilderInterface {
      * ### Examples
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * db.schema
      *   .createTable('pet')
      *   .addColumn('number_of_legs', 'integer', (col) =>
-     *     col.check(db.raw('number_of_legs < 5'))
+     *     col.check(sql`number_of_legs < 5`)
      *   )
      *   .execute()
      * ```
@@ -118,10 +123,12 @@ export interface ColumnDefinitionBuilderInterface {
      * ### Examples
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * db.schema
      *   .createTable('person')
      *   .addColumn('full_name', 'varchar(255)',
-     *     (col) => col.generatedAlwaysAs(db.raw("concat(first_name, ' ', last_name)"))
+     *     (col) => col.generatedAlwaysAs(sql`concat(first_name, ' ', last_name)`)
      *   )
      *   .execute()
      * ```
@@ -235,15 +242,18 @@ export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderI
      *   .execute()
      * ```
      *
-     * Raw expressions are also supported:
+     * Values passed to `defaultTo` are interpreted as value literals by default. You can define
+     * an arbitrary SQL expression using the {@link sql} template tag:
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * db.schema
      *   .createTable('pet')
      *   .addColumn(
      *     'number_of_legs',
      *     'integer',
-     *     (col) => col.defaultTo(db.raw('any SQL here'))
+     *     (col) => col.defaultTo(sql`any SQL here`)
      *   )
      *   .execute()
      * ```
@@ -255,10 +265,12 @@ export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderI
      * ### Examples
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * db.schema
      *   .createTable('pet')
      *   .addColumn('number_of_legs', 'integer', (col) =>
-     *     col.check(db.raw('number_of_legs < 5'))
+     *     col.check(sql`number_of_legs < 5`)
      *   )
      *   .execute()
      * ```
@@ -270,10 +282,12 @@ export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderI
      * ### Examples
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * db.schema
      *   .createTable('person')
      *   .addColumn('full_name', 'varchar(255)',
-     *     (col) => col.generatedAlwaysAs(db.raw("concat(first_name, ' ', last_name)"))
+     *     (col) => col.generatedAlwaysAs(sql`concat(first_name, ' ', last_name)`)
      *   )
      *   .execute()
      * ```

package/dist/cjs/schema/create-index-builder.d.ts

@@ -34,10 +34,12 @@ export declare class CreateIndexBuilder implements OperationNodeSource, Compilab
      * ### Examples
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * await db.schema
      *   .createIndex('person_first_name_index')
      *   .on('person')
-     *   .expression(db.raw('first_name COLLATE "fi_FI"'))
+     *   .expression(sql`first_name COLLATE "fi_FI"`)
      *   .execute()
      * ```
      */

package/dist/cjs/schema/create-index-builder.js

@@ -67,10 +67,12 @@ class CreateIndexBuilder {
      * ### Examples
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * await db.schema
      *   .createIndex('person_first_name_index')
      *   .on('person')
-     *   .expression(db.raw('first_name COLLATE "fi_FI"'))
+     *   .expression(sql`first_name COLLATE "fi_FI"`)
      *   .execute()
      * ```
      */

package/dist/cjs/schema/create-table-builder.d.ts

@@ -39,13 +39,15 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
      * ### Examples
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * await db.schema
      *   .createTable('person')
      *   .addColumn('id', 'integer', (col) => col.autoIncrement().primaryKey()),
      *   .addColumn('first_name', 'varchar(50)', (col) => col.notNull())
      *   .addColumn('last_name', 'varchar(255)')
      *   .addColumn('bank_balance', 'numeric(8, 2)')
-     *   .addColumn('data', db.raw('customtype'))
+     *   .addColumn('data', sql`customtype`)
      *   .addColumn('parent_id', 'integer', (col) =>
      *     col.references('person.id').onDelete('cascade'))
      *   )
@@ -111,7 +113,9 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
      * ### Examples
      *
      * ```ts
-     * addCheckConstraint('check_legs', db.raw('number_of_legs < 5'))
+     * import { sql } from 'kysely'
+     *
+     * addCheckConstraint('check_legs', sql`number_of_legs < 5`)
      * ```
      */
     addCheckConstraint(constraintName: string, checkExpression: AnyRawBuilder): CreateTableBuilder<TB, C>;
@@ -132,7 +136,7 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
      * )
      * ```
      *
-     * Add constraintfor multiple columns:
+     * Add constraint for multiple columns:
      *
      * ```ts
      * addForeignKeyConstraint(

package/dist/cjs/schema/create-table-builder.js

@@ -68,13 +68,15 @@ class CreateTableBuilder {
      * ### Examples
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * await db.schema
      *   .createTable('person')
      *   .addColumn('id', 'integer', (col) => col.autoIncrement().primaryKey()),
      *   .addColumn('first_name', 'varchar(50)', (col) => col.notNull())
      *   .addColumn('last_name', 'varchar(255)')
      *   .addColumn('bank_balance', 'numeric(8, 2)')
-     *   .addColumn('data', db.raw('customtype'))
+     *   .addColumn('data', sql`customtype`)
      *   .addColumn('parent_id', 'integer', (col) =>
      *     col.references('person.id').onDelete('cascade'))
      *   )
@@ -156,7 +158,9 @@ class CreateTableBuilder {
      * ### Examples
      *
      * ```ts
-     * addCheckConstraint('check_legs', db.raw('number_of_legs < 5'))
+     * import { sql } from 'kysely'
+     *
+     * addCheckConstraint('check_legs', sql`number_of_legs < 5`)
      * ```
      */
     addCheckConstraint(constraintName, checkExpression) {
@@ -182,7 +186,7 @@ class CreateTableBuilder {
      * )
      * ```
      *
-     * Add constraintfor multiple columns:
+     * Add constraint for multiple columns:
      *
      * ```ts
      * addForeignKeyConstraint(

package/dist/cjs/schema/create-view-builder.d.ts

@@ -26,9 +26,9 @@ export declare class CreateViewBuilder implements OperationNodeSource, Compilabl
      *
      * WARNING!
      * Some dialects don't support parameterized queries in DDL statements and therefore
-     * the query or `raw` expression passed here is interpolated into a single string
-     * opening an SQL injection vulnerability. DO NOT pass unchecked user input into
-     * the query or `raw` expression passed to this method!
+     * the query or raw {@link sql } expression passed here is interpolated into a single
+     * string opening an SQL injection vulnerability. DO NOT pass unchecked user input
+     * into the query or raw expression passed to this method!
      */
     as(query: AnySelectQueryBuilder | AnyRawBuilder): CreateViewBuilder;
     toOperationNode(): CreateViewNode;

package/dist/cjs/schema/create-view-builder.js

@@ -64,9 +64,9 @@ class CreateViewBuilder {
      *
      * WARNING!
      * Some dialects don't support parameterized queries in DDL statements and therefore
-     * the query or `raw` expression passed here is interpolated into a single string
-     * opening an SQL injection vulnerability. DO NOT pass unchecked user input into
-     * the query or `raw` expression passed to this method!
+     * the query or raw {@link sql } expression passed here is interpolated into a single
+     * string opening an SQL injection vulnerability. DO NOT pass unchecked user input
+     * into the query or raw expression passed to this method!
      */
     as(query) {
         const queryNode = query

package/dist/cjs/util/query-id.js

@@ -1,11 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createQueryId = void 0;
-const object_utils_js_1 = require("./object-utils.js");
 const random_string_js_1 = require("./random-string.js");
 function createQueryId() {
-    return (0, object_utils_js_1.freeze)({
-        queryId: (0, random_string_js_1.randomString)(8),
-    });
+    return new LazyQueryId();
 }
 exports.createQueryId = createQueryId;
+class LazyQueryId {
+    #queryId;
+    get queryId() {
+        if (this.#queryId === undefined) {
+            this.#queryId = (0, random_string_js_1.randomString)(8);
+        }
+        return this.#queryId;
+    }
+}

package/dist/cjs/util/random-string.js

@@ -1,7 +1,70 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.randomString = void 0;
-const CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+const CHARS = [
+    'A',
+    'B',
+    'C',
+    'D',
+    'E',
+    'F',
+    'G',
+    'H',
+    'I',
+    'J',
+    'K',
+    'L',
+    'M',
+    'N',
+    'O',
+    'P',
+    'Q',
+    'R',
+    'S',
+    'T',
+    'U',
+    'V',
+    'W',
+    'X',
+    'Y',
+    'Z',
+    'a',
+    'b',
+    'c',
+    'd',
+    'e',
+    'f',
+    'g',
+    'h',
+    'i',
+    'j',
+    'k',
+    'l',
+    'm',
+    'n',
+    'o',
+    'p',
+    'q',
+    'r',
+    's',
+    't',
+    'u',
+    'v',
+    'w',
+    'x',
+    'y',
+    'z',
+    '0',
+    '1',
+    '2',
+    '3',
+    '4',
+    '5',
+    '6',
+    '7',
+    '8',
+    '9',
+];
 function randomString(length) {
     let chars = '';
     for (let i = 0; i < length; ++i) {
@@ -11,5 +74,5 @@ function randomString(length) {
 }
 exports.randomString = randomString;
 function randomChar() {
-    return CHARS[Math.floor(Math.random() * CHARS.length)];
+    return CHARS[~~(Math.random() * CHARS.length)];
 }

package/dist/cjs/util/type-utils.d.ts

@@ -74,7 +74,7 @@ export declare type ExtractColumnType<DB, TB extends keyof DB, C> = {
  *   movie: Movie
  * }
  *
- * type Columns = AnyColumn<Database, 'person' | 'pet'>
+ * type Columns = AnyColumnWithTable<Database, 'person' | 'pet'>
  *
  * // Columns == 'person.id' | 'pet.name' | 'pet.species'
  * ```

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

@@ -1,4 +1,5 @@
 /// <reference types="./mysql-adapter.d.ts" />
+import { sql } from '../../raw-builder/sql.js';
 import { DialectAdapterBase } from '../dialect-adapter-base.js';
 const LOCK_ID = 'ea586330-2c93-47c8-908d-981d9d270f9d';
 const LOCK_TIMEOUT_SECONDS = 60 * 60;
@@ -16,11 +17,9 @@ export class MysqlAdapter extends DialectAdapterBase {
         // is released using `release_lock`. This way we know that the lock is either
         // released by us after successfull or failed migrations OR it's released by
         // MySQL if the process gets killed for some reason.
-        await db
-            .raw(`select get_lock('${LOCK_ID}', ${LOCK_TIMEOUT_SECONDS})`)
-            .execute();
+        await sql `select get_lock(${sql.literal(LOCK_ID)}, ${sql.literal(LOCK_TIMEOUT_SECONDS)})`.execute(db);
     }
     async releaseMigrationLock(db) {
-        await db.raw(`select release_lock('${LOCK_ID}')`).execute();
+        await sql `select release_lock(${sql.literal(LOCK_ID)})`.execute(db);
     }
 }

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

@@ -202,4 +202,23 @@ export interface MysqlSslOptions {
      * You can also connect to a MySQL server without properly providing the appropriate CA to trust. You should not do this.
      */
     rejectUnauthorized?: boolean;
+    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;
+    };
 }

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

@@ -1,6 +1,7 @@
 /// <reference types="./mysql-introspector.d.ts" />
 import { MIGRATION_LOCK_TABLE, 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) {
@@ -10,7 +11,7 @@ export class MysqlIntrospector {
         let query = this.#db
             .selectFrom('information_schema.columns')
             .selectAll()
-            .where('table_schema', '=', this.#db.raw('database()'))
+            .where('table_schema', '=', sql `database()`)
             .castTo();
         if (!options.withInternalKyselyTables) {
             query = query

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

@@ -1,7 +1,8 @@
 /// <reference types="./postgres-adapter.d.ts" />
+import { sql } from '../../raw-builder/sql.js';
 import { DialectAdapterBase } from '../dialect-adapter-base.js';
 // Random id for our transaction lock.
-const LOCK_ID = '3853314791062309107';
+const LOCK_ID = 3853314791062309107n;
 export class PostgresAdapter extends DialectAdapterBase {
     get supportsTransactionalDdl() {
         return true;
@@ -11,7 +12,7 @@ export class PostgresAdapter extends DialectAdapterBase {
     }
     async acquireMigrationLock(db) {
         // Acquire a transaction level advisory lock.
-        await db.raw(`select pg_advisory_xact_lock(${LOCK_ID})`).execute();
+        await sql `select pg_advisory_xact_lock(${sql.literal(LOCK_ID)})`.execute(db);
     }
     async releaseMigrationLock() {
         // Nothing to do here. `pg_advisory_xact_lock` is automatically released at the

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

@@ -1,5 +1,6 @@
 /// <reference types="./sqlite-introspector.d.ts" />
 import { MIGRATION_LOCK_TABLE, MIGRATION_TABLE, } from '../../migration/migrator.js';
+import { sql } from '../../raw-builder/sql.js';
 export class SqliteIntrospector {
     #db;
     constructor(db) {
@@ -25,7 +26,7 @@ export class SqliteIntrospector {
     async #getTableMetadata(table) {
         const db = this.#db;
         const columns = await db
-            .selectFrom(db.raw(`PRAGMA_TABLE_INFO(?)`, [table]).as('table_info'))
+            .selectFrom(sql `PRAGMA_TABLE_INFO(${table})`.as('table_info'))
             .select(['name', 'type', 'notnull'])
             .castTo()
             .execute();

package/dist/esm/driver/connection-provider.d.ts

@@ -4,5 +4,5 @@ export interface ConnectionProvider {
      * Provides a connection for the callback and takes care of disposing
      * the connection after the callback has been run.
      */
-    withConnection<T>(runner: (connection: DatabaseConnection) => Promise<T>): Promise<T>;
+    provideConnection<T>(consumer: (connection: DatabaseConnection) => Promise<T>): Promise<T>;
 }

package/dist/esm/driver/default-connection-provider.d.ts

@@ -8,5 +8,5 @@ export declare class DefaultConnectionProvider implements ConnectionProvider {
      * Provides a connection for the callback and takes care of disposing
      * the connection after the callback has been run.
      */
-    withConnection<T>(runner: (connection: DatabaseConnection) => Promise<T>): Promise<T>;
+    provideConnection<T>(consumer: (connection: DatabaseConnection) => Promise<T>): Promise<T>;
 }

package/dist/esm/driver/default-connection-provider.js

@@ -4,10 +4,10 @@ export class DefaultConnectionProvider {
     constructor(driver) {
         this.#driver = driver;
     }
-    async withConnection(runner) {
+    async provideConnection(consumer) {
         const connection = await this.#driver.acquireConnection();
         try {
-            return await runner(connection);
+            return await consumer(connection);
         }
         finally {
             await this.#driver.releaseConnection(connection);

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

@@ -27,6 +27,14 @@ import { Driver } from './driver.js';
  *   },
  * })
  * ```
+ *
+ * You can use it to build a query and compile it to SQL but trying to
+ * execute the query will throw an error.
+ *
+ * ```ts
+ * const { sql } = db.selectFrom('person').selectAll().compile()
+ * console.log(sql) // select * from "person"
+ * ```
  */
 export declare class DummyDriver implements Driver {
     /**

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

@@ -26,6 +26,14 @@
  *   },
  * })
  * ```
+ *
+ * You can use it to build a query and compile it to SQL but trying to
+ * execute the query will throw an error.
+ *
+ * ```ts
+ * const { sql } = db.selectFrom('person').selectAll().compile()
+ * console.log(sql) // select * from "person"
+ * ```
  */
 export class DummyDriver {
     async init() {

package/dist/esm/driver/single-connection-provider.d.ts

@@ -7,5 +7,5 @@ export declare class SingleConnectionProvider implements ConnectionProvider {
      * Provides a connection for the callback and takes care of disposing
      * the connection after the callback has been run.
      */
-    withConnection<T>(runner: (connection: DatabaseConnection) => Promise<T>): Promise<T>;
+    provideConnection<T>(consumer: (connection: DatabaseConnection) => Promise<T>): Promise<T>;
 }

package/dist/esm/driver/single-connection-provider.js

@@ -5,11 +5,11 @@ export class SingleConnectionProvider {
     constructor(connection) {
         this.#connection = connection;
     }
-    async withConnection(runner) {
+    async provideConnection(consumer) {
         while (this.#runningPromise) {
             await this.#runningPromise;
         }
-        const promise = this.#run(runner);
+        const promise = this.#run(consumer);
         this.#runningPromise = promise
             .then(() => {
             this.#runningPromise = undefined;

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

@@ -17,9 +17,11 @@ 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';

package/dist/esm/index-nodeless.js

@@ -18,9 +18,11 @@ 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';

package/dist/esm/kysely.d.ts

@@ -6,11 +6,9 @@ import { QueryCreator } from './query-creator.js';
 import { KyselyPlugin } from './plugin/kysely-plugin.js';
 import { DatabaseIntrospector } from './dialect/database-introspector.js';
 import { Driver, IsolationLevel } from './driver/driver.js';
-import { ParseContext } from './parser/parse-context.js';
 import { FunctionBuilder } from './query-builder/function-builder.js';
 import { LogConfig } from './util/log.js';
-import { PRIVATE_ADAPTER } from './util/private-symbols.js';
-import { DialectAdapter } from './dialect/dialect-adapter.js';
+import { QueryExecutorProvider } from './query-executor/query-executor-provider.js';
 /**
  * The main Kysely class.
  *
@@ -54,7 +52,7 @@ import { DialectAdapter } from './dialect/dialect-adapter.js';
  *    in the database and values must be interfaces that describe the rows in those
  *    tables. See the examples above.
  */
-export declare class Kysely<DB> extends QueryCreator<DB> {
+export declare class Kysely<DB> extends QueryCreator<DB> implements QueryExecutorProvider {
     #private;
     constructor(args: KyselyConfig);
     constructor(args: KyselyProps);
@@ -226,7 +224,7 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
      * @internal
      * @private
      */
-    get [PRIVATE_ADAPTER](): DialectAdapter;
+    getExecutor(): QueryExecutor;
 }
 export declare class Transaction<DB> extends Kysely<DB> {
     #private;
@@ -357,7 +355,6 @@ export interface KyselyProps {
     readonly driver: Driver;
     readonly executor: QueryExecutor;
     readonly dialect: Dialect;
-    readonly parseContext: ParseContext;
 }
 export declare function isKyselyProps(obj: unknown): obj is KyselyProps;
 export interface KyselyConfig {