kysely 0.16.11 → 0.17.2

package/dist/esm/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/esm/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/esm/schema/create-index-builder.js

@@ -65,10 +65,12 @@ export 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/esm/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/esm/schema/create-table-builder.js

@@ -66,13 +66,15 @@ export 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'))
      *   )
@@ -154,7 +156,9 @@ export 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) {
@@ -180,7 +184,7 @@ export class CreateTableBuilder {
      * )
      * ```
      *
-     * Add constraintfor multiple columns:
+     * Add constraint for multiple columns:
      *
      * ```ts
      * addForeignKeyConstraint(

package/dist/esm/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/esm/schema/create-view-builder.js

@@ -62,9 +62,9 @@ export 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/esm/util/query-id.js

@@ -1,8 +1,14 @@
 /// <reference types="./query-id.d.ts" />
-import { freeze } from './object-utils.js';
 import { randomString } from './random-string.js';
 export function createQueryId() {
-    return freeze({
-        queryId: randomString(8),
-    });
+    return new LazyQueryId();
+}
+class LazyQueryId {
+    #queryId;
+    get queryId() {
+        if (this.#queryId === undefined) {
+            this.#queryId = randomString(8);
+        }
+        return this.#queryId;
+    }
 }

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

@@ -1,5 +1,68 @@
 /// <reference types="./random-string.d.ts" />
-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',
+];
 export function randomString(length) {
     let chars = '';
     for (let i = 0; i < length; ++i) {
@@ -8,5 +71,5 @@ export function randomString(length) {
     return chars;
 }
 function randomChar() {
-    return CHARS[Math.floor(Math.random() * CHARS.length)];
+    return CHARS[~~(Math.random() * CHARS.length)];
 }

package/dist/esm/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.16.11",
+  "version": "0.17.2",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -47,22 +47,22 @@
     "@types/node": "^16.11.9"
   },
   "devDependencies": {
-    "@types/better-sqlite3": "^7.4.1",
+    "@types/better-sqlite3": "^7.5.0",
     "@types/chai": "^4.3.0",
     "@types/chai-subset": "^1.3.3",
-    "@types/mocha": "^9.0.0",
-    "@types/pg": "^8.6.1",
-    "better-sqlite3": "^7.4.5",
-    "chai": "^4.3.4",
+    "@types/mocha": "^9.1.0",
+    "@types/pg": "^8.6.5",
+    "better-sqlite3": "^7.5.0",
+    "chai": "^4.3.6",
     "chai-subset": "^1.6.0",
-    "esbuild": "^0.14.11",
-    "mocha": "^9.1.3",
+    "esbuild": "^0.14.27",
+    "mocha": "^9.2.2",
     "mysql2": "^2.3.3",
-    "pg": "^8.7.1",
-    "playwright": "^1.17.2",
-    "prettier": "^2.5.1",
-    "tsd": "^0.19.0",
-    "typedoc": "^0.22.10",
-    "typescript": "4.5.3"
+    "pg": "^8.7.3",
+    "playwright": "^1.20.0",
+    "prettier": "^2.6.0",
+    "tsd": "^0.19.1",
+    "typedoc": "^0.22.13",
+    "typescript": "4.6.2"
   }
 }

package/dist/cjs/parser/parse-context.d.ts

@@ -1,55 +0,0 @@
-import { DialectAdapter } from '../dialect/dialect-adapter.js';
-import { JoinType } from '../operation-node/join-node.js';
-import { JoinBuilder } from '../query-builder/join-builder.js';
-import { SelectQueryBuilder } from '../query-builder/select-query-builder.js';
-import { ExpressionBuilder } from '../query-builder/expression-builder.js';
-import { QueryCreator } from '../query-creator.js';
-import { TableExpression } from './table-parser.js';
-/**
- * This interface exposes everything the parsers need to be able to parse
- * method calls into {@link OperationNode} trees.
- */
-export interface ParseContext {
-    readonly adapter: DialectAdapter;
-    /**
-     * Creates a select query builder with a {@link NoopQueryExecutor}.
-     */
-    createSelectQueryBuilder(): SelectQueryBuilder<any, any, any>;
-    /**
-     * Creates an expression builder for building stuff like subqueries.
-     * {@link NoopQueryExecutor} is used as the executor and the queries
-     * built using the returned builder can never be executed.
-     */
-    createExpressionBuilder(): ExpressionBuilder<any, any>;
-    /**
-     * Creates a query creator with a {@link NoopQueryExecutor}.
-     */
-    createQueryCreator(): QueryCreator<any>;
-    /**
-     * Creates an instance of a join builder.
-     */
-    createJoinBuilder(joinType: JoinType, table: TableExpression<any, any>): JoinBuilder<any, any>;
-}
-export declare class DefaultParseContext implements ParseContext {
-    #private;
-    constructor(adapter: DialectAdapter);
-    get adapter(): DialectAdapter;
-    /**
-     * Creates a select query builder with a {@link NoopQueryExecutor}.
-     */
-    createSelectQueryBuilder(): SelectQueryBuilder<any, any, any>;
-    /**
-     * Creates an expression builder for building stuff like subqueries.
-     * {@link NoopQueryExecutor} is used as the executor and the queries
-     * built using the returned builder can never be executed.
-     */
-    createExpressionBuilder(): ExpressionBuilder<any, any>;
-    /**
-     * Creates a query creator with a {@link NoopQueryExecutor}.
-     */
-    createQueryCreator(): QueryCreator<any>;
-    /**
-     * Creates an instance of a join builder.
-     */
-    createJoinBuilder(joinType: JoinType, table: TableExpression<any, any>): JoinBuilder<any, any>;
-}

package/dist/cjs/parser/parse-context.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultParseContext = void 0;
-const join_node_js_1 = require("../operation-node/join-node.js");
-const select_query_node_js_1 = require("../operation-node/select-query-node.js");
-const join_builder_js_1 = require("../query-builder/join-builder.js");
-const select_query_builder_js_1 = require("../query-builder/select-query-builder.js");
-const expression_builder_js_1 = require("../query-builder/expression-builder.js");
-const query_creator_js_1 = require("../query-creator.js");
-const noop_query_executor_js_1 = require("../query-executor/noop-query-executor.js");
-const query_id_js_1 = require("../util/query-id.js");
-const table_parser_js_1 = require("./table-parser.js");
-class DefaultParseContext {
-    #adapter;
-    #noopExecutor;
-    constructor(adapter) {
-        this.#adapter = adapter;
-        this.#noopExecutor = new noop_query_executor_js_1.NoopQueryExecutor();
-    }
-    get adapter() {
-        return this.#adapter;
-    }
-    createSelectQueryBuilder() {
-        return new select_query_builder_js_1.SelectQueryBuilder({
-            queryId: (0, query_id_js_1.createQueryId)(),
-            executor: this.#noopExecutor,
-            parseContext: this,
-            queryNode: select_query_node_js_1.SelectQueryNode.create((0, table_parser_js_1.parseTableExpressionOrList)(this, [])),
-        });
-    }
-    createExpressionBuilder() {
-        return new expression_builder_js_1.ExpressionBuilder({
-            executor: this.#noopExecutor,
-            parseContext: this,
-        });
-    }
-    createQueryCreator() {
-        return new query_creator_js_1.QueryCreator({
-            executor: this.#noopExecutor,
-            parseContext: this,
-        });
-    }
-    createJoinBuilder(joinType, table) {
-        return new join_builder_js_1.JoinBuilder({
-            joinNode: join_node_js_1.JoinNode.create(joinType, (0, table_parser_js_1.parseTableExpression)(this, table)),
-            parseContext: this,
-        });
-    }
-}
-exports.DefaultParseContext = DefaultParseContext;

package/dist/cjs/util/private-symbols.d.ts

@@ -1,5 +0,0 @@
-/**
- * @internal
- * @private
- */
-export declare const PRIVATE_ADAPTER: unique symbol;

package/dist/cjs/util/private-symbols.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PRIVATE_ADAPTER = void 0;
-/**
- * @internal
- * @private
- */
-exports.PRIVATE_ADAPTER = Symbol();

package/dist/esm/parser/parse-context.d.ts

@@ -1,55 +0,0 @@
-import { DialectAdapter } from '../dialect/dialect-adapter.js';
-import { JoinType } from '../operation-node/join-node.js';
-import { JoinBuilder } from '../query-builder/join-builder.js';
-import { SelectQueryBuilder } from '../query-builder/select-query-builder.js';
-import { ExpressionBuilder } from '../query-builder/expression-builder.js';
-import { QueryCreator } from '../query-creator.js';
-import { TableExpression } from './table-parser.js';
-/**
- * This interface exposes everything the parsers need to be able to parse
- * method calls into {@link OperationNode} trees.
- */
-export interface ParseContext {
-    readonly adapter: DialectAdapter;
-    /**
-     * Creates a select query builder with a {@link NoopQueryExecutor}.
-     */
-    createSelectQueryBuilder(): SelectQueryBuilder<any, any, any>;
-    /**
-     * Creates an expression builder for building stuff like subqueries.
-     * {@link NoopQueryExecutor} is used as the executor and the queries
-     * built using the returned builder can never be executed.
-     */
-    createExpressionBuilder(): ExpressionBuilder<any, any>;
-    /**
-     * Creates a query creator with a {@link NoopQueryExecutor}.
-     */
-    createQueryCreator(): QueryCreator<any>;
-    /**
-     * Creates an instance of a join builder.
-     */
-    createJoinBuilder(joinType: JoinType, table: TableExpression<any, any>): JoinBuilder<any, any>;
-}
-export declare class DefaultParseContext implements ParseContext {
-    #private;
-    constructor(adapter: DialectAdapter);
-    get adapter(): DialectAdapter;
-    /**
-     * Creates a select query builder with a {@link NoopQueryExecutor}.
-     */
-    createSelectQueryBuilder(): SelectQueryBuilder<any, any, any>;
-    /**
-     * Creates an expression builder for building stuff like subqueries.
-     * {@link NoopQueryExecutor} is used as the executor and the queries
-     * built using the returned builder can never be executed.
-     */
-    createExpressionBuilder(): ExpressionBuilder<any, any>;
-    /**
-     * Creates a query creator with a {@link NoopQueryExecutor}.
-     */
-    createQueryCreator(): QueryCreator<any>;
-    /**
-     * Creates an instance of a join builder.
-     */
-    createJoinBuilder(joinType: JoinType, table: TableExpression<any, any>): JoinBuilder<any, any>;
-}

package/dist/esm/parser/parse-context.js

@@ -1,47 +0,0 @@
-/// <reference types="./parse-context.d.ts" />
-import { JoinNode } from '../operation-node/join-node.js';
-import { SelectQueryNode } from '../operation-node/select-query-node.js';
-import { JoinBuilder } from '../query-builder/join-builder.js';
-import { SelectQueryBuilder } from '../query-builder/select-query-builder.js';
-import { ExpressionBuilder } from '../query-builder/expression-builder.js';
-import { QueryCreator } from '../query-creator.js';
-import { NoopQueryExecutor } from '../query-executor/noop-query-executor.js';
-import { createQueryId } from '../util/query-id.js';
-import { parseTableExpression, parseTableExpressionOrList, } from './table-parser.js';
-export class DefaultParseContext {
-    #adapter;
-    #noopExecutor;
-    constructor(adapter) {
-        this.#adapter = adapter;
-        this.#noopExecutor = new NoopQueryExecutor();
-    }
-    get adapter() {
-        return this.#adapter;
-    }
-    createSelectQueryBuilder() {
-        return new SelectQueryBuilder({
-            queryId: createQueryId(),
-            executor: this.#noopExecutor,
-            parseContext: this,
-            queryNode: SelectQueryNode.create(parseTableExpressionOrList(this, [])),
-        });
-    }
-    createExpressionBuilder() {
-        return new ExpressionBuilder({
-            executor: this.#noopExecutor,
-            parseContext: this,
-        });
-    }
-    createQueryCreator() {
-        return new QueryCreator({
-            executor: this.#noopExecutor,
-            parseContext: this,
-        });
-    }
-    createJoinBuilder(joinType, table) {
-        return new JoinBuilder({
-            joinNode: JoinNode.create(joinType, parseTableExpression(this, table)),
-            parseContext: this,
-        });
-    }
-}

package/dist/esm/util/private-symbols.d.ts

@@ -1,5 +0,0 @@
-/**
- * @internal
- * @private
- */
-export declare const PRIVATE_ADAPTER: unique symbol;

package/dist/esm/util/private-symbols.js

@@ -1,6 +0,0 @@
-/// <reference types="./private-symbols.d.ts" />
-/**
- * @internal
- * @private
- */
-export const PRIVATE_ADAPTER = Symbol();