kysely 0.23.1 → 0.23.3

package/dist/esm/query-builder/update-query-builder.js

@@ -4,7 +4,7 @@ import { parseTableExpressionOrList, } from '../parser/table-parser.js';
 import { parseSelectExpressionOrList, parseSelectAll, } from '../parser/select-parser.js';
 import { QueryNode } from '../operation-node/query-node.js';
 import { UpdateQueryNode } from '../operation-node/update-query-node.js';
-import { parseUpdateObject, } from '../parser/update-set-parser.js';
+import { parseUpdateObject } from '../parser/update-set-parser.js';
 import { preventAwait } from '../util/prevent-await.js';
 import { freeze } from '../util/object-utils.js';
 import { UpdateResult } from './update-result.js';
@@ -65,6 +65,12 @@ export class UpdateQueryBuilder {
             queryNode: QueryNode.cloneWithOrWhere(this.#props.queryNode, parseNotExists(arg)),
         });
     }
+    clearWhere() {
+        return new UpdateQueryBuilder({
+            ...this.#props,
+            queryNode: QueryNode.cloneWithoutWhere(this.#props.queryNode),
+        });
+    }
     from(from) {
         return new UpdateQueryBuilder({
             ...this.#props,
@@ -208,7 +214,7 @@ export class UpdateQueryBuilder {
      *
      * ### Examples
      *
-     * The next example uses a helper funtion `log` to log a query:
+     * The next example uses a helper function `log` to log a query:
      *
      * ```ts
      * function log<T extends Compilable>(qb: T): T {
@@ -278,6 +284,52 @@ export class UpdateQueryBuilder {
     castTo() {
         return new UpdateQueryBuilder(this.#props);
     }
+    /**
+     * Asserts that query's output row type equals the given type `T`.
+     *
+     * This method can be used to simplify excessively complex types to make typescript happy
+     * and much faster.
+     *
+     * Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
+     * for typescript and you get errors like this:
+     *
+     * ```
+     * error TS2589: Type instantiation is excessively deep and possibly infinite.
+     * ```
+     *
+     * In these case you can often use this method to help typescript a little bit. When you use this
+     * method to assert the output type of a query, Kysely can drop the complex output type that
+     * consists of multiple nested helper types and replace it with the simple asserted type.
+     *
+     * Using this method doesn't reduce type safety at all. You have to pass in a type that is
+     * structurally equal to the current type.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * const result = await db
+     *   .with('updated_person', (qb) => qb
+     *     .updateTable('person')
+     *     .set(person)
+     *     .where('id', '=', person.id)
+     *     .returning('first_name')
+     *     .assertType<{ first_name: string }>()
+     *   )
+     *   .with('updated_pet', (qb) => qb
+     *     .updateTable('pet')
+     *     .set(pet)
+     *     .where('owner_id', '=', person.id)
+     *     .returning(['name as pet_name', 'species'])
+     *     .assertType<{ pet_name: string, species: Species }>()
+     *   )
+     *   .selectFrom(['updated_person', 'updated_pet'])
+     *   .selectAll()
+     *   .executeTakeFirstOrThrow()
+     * ```
+     */
+    assertType() {
+        return new UpdateQueryBuilder(this.#props);
+    }
     /**
      * Returns a copy of this UpdateQueryBuilder instance with the given plugin installed.
      */

package/dist/esm/query-builder/where-interface.d.ts

@@ -387,4 +387,23 @@ export interface WhereInterface<DB, TB extends keyof DB> {
      * Just like {@link whereExists} but creates an `or not exists` clause.
      */
     orWhereNotExists(arg: ExistsExpression<DB, TB>): WhereInterface<DB, TB>;
+    /**
+     * Clears all where clauses from the query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .selectAll()
+     *   .where('id','=',42)
+     *   .clearWhere()
+     * ```
+     *
+     * The generated SQL(PostgreSQL):
+     *
+     * ```sql
+     * select * from "person"
+     * ```
+     */
+    clearWhere(): WhereInterface<DB, TB>;
 }

package/dist/esm/schema/alter-table-add-foreign-key-constraint-builder.d.ts

@@ -0,0 +1,23 @@
+import { AlterTableNode } from '../operation-node/alter-table-node.js';
+import { OperationNodeSource } from '../operation-node/operation-node-source.js';
+import { OnModifyForeignAction } from '../operation-node/references-node.js';
+import { CompiledQuery } from '../query-compiler/compiled-query.js';
+import { QueryExecutor } from '../query-executor/query-executor.js';
+import { Compilable } from '../util/compilable.js';
+import { QueryId } from '../util/query-id.js';
+import { ForeignKeyConstraintBuilder, ForeignKeyConstraintBuilderInterface } from './foreign-key-constraint-builder.js';
+export declare class AlterTableAddForeignKeyConstraintBuilder implements ForeignKeyConstraintBuilderInterface<AlterTableAddForeignKeyConstraintBuilder>, OperationNodeSource, Compilable {
+    #private;
+    constructor(props: AlterTableAddForeignKeyConstraintBuilderProps);
+    onDelete(onDelete: OnModifyForeignAction): AlterTableAddForeignKeyConstraintBuilder;
+    onUpdate(onUpdate: OnModifyForeignAction): AlterTableAddForeignKeyConstraintBuilder;
+    toOperationNode(): AlterTableNode;
+    compile(): CompiledQuery;
+    execute(): Promise<void>;
+}
+export interface AlterTableAddForeignKeyConstraintBuilderProps {
+    readonly queryId: QueryId;
+    readonly executor: QueryExecutor;
+    readonly node: AlterTableNode;
+    readonly constraintBuilder: ForeignKeyConstraintBuilder;
+}

package/dist/esm/schema/alter-table-add-foreign-key-constraint-builder.js

@@ -0,0 +1,35 @@
+/// <reference types="./alter-table-add-foreign-key-constraint-builder.d.ts" />
+import { AddConstraintNode } from '../operation-node/add-constraint-node.js';
+import { AlterTableNode } from '../operation-node/alter-table-node.js';
+import { freeze } from '../util/object-utils.js';
+import { preventAwait } from '../util/prevent-await.js';
+export class AlterTableAddForeignKeyConstraintBuilder {
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
+    }
+    onDelete(onDelete) {
+        return new AlterTableAddForeignKeyConstraintBuilder({
+            ...this.#props,
+            constraintBuilder: this.#props.constraintBuilder.onDelete(onDelete),
+        });
+    }
+    onUpdate(onUpdate) {
+        return new AlterTableAddForeignKeyConstraintBuilder({
+            ...this.#props,
+            constraintBuilder: this.#props.constraintBuilder.onUpdate(onUpdate),
+        });
+    }
+    toOperationNode() {
+        return this.#props.executor.transformQuery(AlterTableNode.cloneWithTableProps(this.#props.node, {
+            addConstraint: AddConstraintNode.create(this.#props.constraintBuilder.toOperationNode()),
+        }), this.#props.queryId);
+    }
+    compile() {
+        return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
+    }
+    async execute() {
+        await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
+    }
+}
+preventAwait(AlterTableAddForeignKeyConstraintBuilder, "don't await AlterTableAddForeignKeyConstraintBuilder instances directly. To execute the query you need to call `execute`");

package/dist/esm/schema/alter-table-builder.d.ts

@@ -1,15 +1,16 @@
 import { AlterTableNode } from '../operation-node/alter-table-node.js';
 import { OperationNodeSource } from '../operation-node/operation-node-source.js';
-import { OnModifyForeignAction } from '../operation-node/references-node.js';
 import { CompiledQuery } from '../query-compiler/compiled-query.js';
 import { Compilable } from '../util/compilable.js';
 import { ColumnDefinitionBuilderCallback } from './column-definition-builder.js';
 import { QueryId } from '../util/query-id.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
 import { DataTypeExpression } from '../parser/data-type-parser.js';
-import { ForeignKeyConstraintBuilder, ForeignKeyConstraintBuilderInterface } from './foreign-key-constraint-builder.js';
 import { Expression } from '../expression/expression.js';
 import { AlterColumnBuilderCallback } from './alter-column-builder.js';
+import { AlterTableExecutor } from './alter-table-executor.js';
+import { AlterTableAddForeignKeyConstraintBuilder } from './alter-table-add-foreign-key-constraint-builder.js';
+import { AlterTableDropConstraintBuilder } from './alter-table-drop-constraint-builder.js';
 /**
  * This builder can be used to create a `alter table` query.
  */
@@ -60,15 +61,6 @@ export interface AlterTableBuilderProps {
     readonly executor: QueryExecutor;
     readonly node: AlterTableNode;
 }
-export declare class AlterTableExecutor implements OperationNodeSource, Compilable {
-    #private;
-    constructor(props: AlterTableExecutorProps);
-    toOperationNode(): AlterTableNode;
-    compile(): CompiledQuery;
-    execute(): Promise<void>;
-}
-export interface AlterTableExecutorProps extends AlterTableBuilderProps {
-}
 export interface ColumnAlteringInterface {
     alterColumn(column: string, alteration: AlterColumnBuilderCallback): ColumnAlteringInterface;
     dropColumn(column: string): ColumnAlteringInterface;
@@ -106,27 +98,3 @@ export declare class AlterTableColumnAlteringBuilder implements ColumnAlteringIn
 }
 export interface AlterTableColumnAlteringBuilderProps extends AlterTableBuilderProps {
 }
-export declare class AlterTableAddForeignKeyConstraintBuilder implements ForeignKeyConstraintBuilderInterface<AlterTableAddForeignKeyConstraintBuilder>, OperationNodeSource, Compilable {
-    #private;
-    constructor(props: AlterTableAddForeignKeyConstraintBuilderProps);
-    onDelete(onDelete: OnModifyForeignAction): AlterTableAddForeignKeyConstraintBuilder;
-    onUpdate(onUpdate: OnModifyForeignAction): AlterTableAddForeignKeyConstraintBuilder;
-    toOperationNode(): AlterTableNode;
-    compile(): CompiledQuery;
-    execute(): Promise<void>;
-}
-export interface AlterTableAddForeignKeyConstraintBuilderProps extends AlterTableBuilderProps {
-    readonly constraintBuilder: ForeignKeyConstraintBuilder;
-}
-export declare class AlterTableDropConstraintBuilder implements OperationNodeSource, Compilable {
-    #private;
-    constructor(props: AlterTableDropConstraintBuilderProps);
-    ifExists(): AlterTableDropConstraintBuilder;
-    cascade(): AlterTableDropConstraintBuilder;
-    restrict(): AlterTableDropConstraintBuilder;
-    toOperationNode(): AlterTableNode;
-    compile(): CompiledQuery;
-    execute(): Promise<void>;
-}
-export interface AlterTableDropConstraintBuilderProps extends AlterTableBuilderProps {
-}

package/dist/esm/schema/alter-table-builder.js

@@ -11,7 +11,7 @@ import { preventAwait } from '../util/prevent-await.js';
 import { ColumnDefinitionBuilder, } from './column-definition-builder.js';
 import { ModifyColumnNode } from '../operation-node/modify-column-node.js';
 import { parseDataTypeExpression, } from '../parser/data-type-parser.js';
-import { ForeignKeyConstraintBuilder, } from './foreign-key-constraint-builder.js';
+import { ForeignKeyConstraintBuilder } from './foreign-key-constraint-builder.js';
 import { AddConstraintNode } from '../operation-node/add-constraint-node.js';
 import { UniqueConstraintNode } from '../operation-node/unique-constraint-node.js';
 import { CheckConstraintNode } from '../operation-node/check-constraint-node.js';
@@ -20,6 +20,9 @@ import { ColumnNode } from '../operation-node/column-node.js';
 import { parseTable } from '../parser/table-parser.js';
 import { DropConstraintNode } from '../operation-node/drop-constraint-node.js';
 import { AlterColumnBuilder, } from './alter-column-builder.js';
+import { AlterTableExecutor } from './alter-table-executor.js';
+import { AlterTableAddForeignKeyConstraintBuilder } from './alter-table-add-foreign-key-constraint-builder.js';
+import { AlterTableDropConstraintBuilder } from './alter-table-drop-constraint-builder.js';
 /**
  * This builder can be used to create a `alter table` query.
  */
@@ -129,21 +132,6 @@ export class AlterTableBuilder {
         return func(this);
     }
 }
-export class AlterTableExecutor {
-    #props;
-    constructor(props) {
-        this.#props = freeze(props);
-    }
-    toOperationNode() {
-        return this.#props.executor.transformQuery(this.#props.node, this.#props.queryId);
-    }
-    compile() {
-        return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
-    }
-    async execute() {
-        await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
-    }
-}
 export class AlterTableColumnAlteringBuilder {
     #props;
     constructor(props) {
@@ -192,83 +180,6 @@ export class AlterTableColumnAlteringBuilder {
         await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
     }
 }
-export class AlterTableAddForeignKeyConstraintBuilder {
-    #props;
-    constructor(props) {
-        this.#props = freeze(props);
-    }
-    onDelete(onDelete) {
-        return new AlterTableAddForeignKeyConstraintBuilder({
-            ...this.#props,
-            constraintBuilder: this.#props.constraintBuilder.onDelete(onDelete),
-        });
-    }
-    onUpdate(onUpdate) {
-        return new AlterTableAddForeignKeyConstraintBuilder({
-            ...this.#props,
-            constraintBuilder: this.#props.constraintBuilder.onUpdate(onUpdate),
-        });
-    }
-    toOperationNode() {
-        return this.#props.executor.transformQuery(AlterTableNode.cloneWithTableProps(this.#props.node, {
-            addConstraint: AddConstraintNode.create(this.#props.constraintBuilder.toOperationNode()),
-        }), this.#props.queryId);
-    }
-    compile() {
-        return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
-    }
-    async execute() {
-        await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
-    }
-}
-export class AlterTableDropConstraintBuilder {
-    #props;
-    constructor(props) {
-        this.#props = freeze(props);
-    }
-    ifExists() {
-        return new AlterTableDropConstraintBuilder({
-            ...this.#props,
-            node: AlterTableNode.cloneWithTableProps(this.#props.node, {
-                dropConstraint: DropConstraintNode.cloneWith(this.#props.node.dropConstraint, {
-                    ifExists: true,
-                }),
-            }),
-        });
-    }
-    cascade() {
-        return new AlterTableDropConstraintBuilder({
-            ...this.#props,
-            node: AlterTableNode.cloneWithTableProps(this.#props.node, {
-                dropConstraint: DropConstraintNode.cloneWith(this.#props.node.dropConstraint, {
-                    modifier: 'cascade',
-                }),
-            }),
-        });
-    }
-    restrict() {
-        return new AlterTableDropConstraintBuilder({
-            ...this.#props,
-            node: AlterTableNode.cloneWithTableProps(this.#props.node, {
-                dropConstraint: DropConstraintNode.cloneWith(this.#props.node.dropConstraint, {
-                    modifier: 'restrict',
-                }),
-            }),
-        });
-    }
-    toOperationNode() {
-        return this.#props.executor.transformQuery(this.#props.node, this.#props.queryId);
-    }
-    compile() {
-        return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
-    }
-    async execute() {
-        await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
-    }
-}
 preventAwait(AlterTableBuilder, "don't await AlterTableBuilder instances");
 preventAwait(AlterColumnBuilder, "don't await AlterColumnBuilder instances");
-preventAwait(AlterTableExecutor, "don't await AlterTableExecutor instances directly. To execute the query you need to call `execute`");
 preventAwait(AlterTableColumnAlteringBuilder, "don't await AlterTableColumnAlteringBuilder instances directly. To execute the query you need to call `execute`");
-preventAwait(AlterTableAddForeignKeyConstraintBuilder, "don't await AlterTableAddForeignKeyConstraintBuilder instances directly. To execute the query you need to call `execute`");
-preventAwait(AlterTableDropConstraintBuilder, "don't await AlterTableDropConstraintBuilder instances directly. To execute the query you need to call `execute`");

package/dist/esm/schema/alter-table-drop-constraint-builder.d.ts

@@ -0,0 +1,21 @@
+import { AlterTableNode } from '../operation-node/alter-table-node.js';
+import { OperationNodeSource } from '../operation-node/operation-node-source.js';
+import { CompiledQuery } from '../query-compiler/compiled-query.js';
+import { QueryExecutor } from '../query-executor/query-executor.js';
+import { Compilable } from '../util/compilable.js';
+import { QueryId } from '../util/query-id.js';
+export declare class AlterTableDropConstraintBuilder implements OperationNodeSource, Compilable {
+    #private;
+    constructor(props: AlterTableDropConstraintBuilderProps);
+    ifExists(): AlterTableDropConstraintBuilder;
+    cascade(): AlterTableDropConstraintBuilder;
+    restrict(): AlterTableDropConstraintBuilder;
+    toOperationNode(): AlterTableNode;
+    compile(): CompiledQuery;
+    execute(): Promise<void>;
+}
+export interface AlterTableDropConstraintBuilderProps {
+    readonly queryId: QueryId;
+    readonly executor: QueryExecutor;
+    readonly node: AlterTableNode;
+}

package/dist/esm/schema/alter-table-drop-constraint-builder.js

@@ -0,0 +1,51 @@
+/// <reference types="./alter-table-drop-constraint-builder.d.ts" />
+import { AlterTableNode } from '../operation-node/alter-table-node.js';
+import { DropConstraintNode } from '../operation-node/drop-constraint-node.js';
+import { freeze } from '../util/object-utils.js';
+import { preventAwait } from '../util/prevent-await.js';
+export class AlterTableDropConstraintBuilder {
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
+    }
+    ifExists() {
+        return new AlterTableDropConstraintBuilder({
+            ...this.#props,
+            node: AlterTableNode.cloneWithTableProps(this.#props.node, {
+                dropConstraint: DropConstraintNode.cloneWith(this.#props.node.dropConstraint, {
+                    ifExists: true,
+                }),
+            }),
+        });
+    }
+    cascade() {
+        return new AlterTableDropConstraintBuilder({
+            ...this.#props,
+            node: AlterTableNode.cloneWithTableProps(this.#props.node, {
+                dropConstraint: DropConstraintNode.cloneWith(this.#props.node.dropConstraint, {
+                    modifier: 'cascade',
+                }),
+            }),
+        });
+    }
+    restrict() {
+        return new AlterTableDropConstraintBuilder({
+            ...this.#props,
+            node: AlterTableNode.cloneWithTableProps(this.#props.node, {
+                dropConstraint: DropConstraintNode.cloneWith(this.#props.node.dropConstraint, {
+                    modifier: 'restrict',
+                }),
+            }),
+        });
+    }
+    toOperationNode() {
+        return this.#props.executor.transformQuery(this.#props.node, this.#props.queryId);
+    }
+    compile() {
+        return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
+    }
+    async execute() {
+        await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
+    }
+}
+preventAwait(AlterTableDropConstraintBuilder, "don't await AlterTableDropConstraintBuilder instances directly. To execute the query you need to call `execute`");

package/dist/esm/schema/alter-table-executor.d.ts

@@ -0,0 +1,18 @@
+import { AlterTableNode } from '../operation-node/alter-table-node.js';
+import { OperationNodeSource } from '../operation-node/operation-node-source.js';
+import { CompiledQuery } from '../query-compiler/compiled-query.js';
+import { QueryExecutor } from '../query-executor/query-executor.js';
+import { Compilable } from '../util/compilable.js';
+import { QueryId } from '../util/query-id.js';
+export declare class AlterTableExecutor implements OperationNodeSource, Compilable {
+    #private;
+    constructor(props: AlterTableExecutorProps);
+    toOperationNode(): AlterTableNode;
+    compile(): CompiledQuery;
+    execute(): Promise<void>;
+}
+export interface AlterTableExecutorProps {
+    readonly queryId: QueryId;
+    readonly executor: QueryExecutor;
+    readonly node: AlterTableNode;
+}

package/dist/esm/schema/alter-table-executor.js

@@ -0,0 +1,19 @@
+/// <reference types="./alter-table-executor.d.ts" />
+import { freeze } from '../util/object-utils.js';
+import { preventAwait } from '../util/prevent-await.js';
+export class AlterTableExecutor {
+    #props;
+    constructor(props) {
+        this.#props = freeze(props);
+    }
+    toOperationNode() {
+        return this.#props.executor.transformQuery(this.#props.node, this.#props.queryId);
+    }
+    compile() {
+        return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
+    }
+    async execute() {
+        await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
+    }
+}
+preventAwait(AlterTableExecutor, "don't await AlterTableExecutor instances directly. To execute the query you need to call `execute`");

package/dist/esm/util/type-error.d.ts

@@ -0,0 +1,3 @@
+export interface KyselyTypeError<E extends string> {
+    readonly __kyselyTypeError__: E;
+}

package/dist/esm/util/type-error.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.23.1",
+  "version": "0.23.3",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "test:typings": "tsd test/typings",
     "test:esmimports": "node scripts/check-esm-imports.js",
     "test:esbuild": "esbuild --bundle --platform=node --external:pg-native dist/esm/index.js --outfile=/dev/null",
-    "prettier": "prettier --write src/**/*.ts test/**/*.ts",
+    "prettier": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
     "build": "npm run clean && npm run build:esm && npm run build:cjs && npm run script:module-fixup && npm run script:copy-interface-doc",
     "build:esm": "tsc -p tsconfig.json && npm run script:add-deno-type-references",
     "build:cjs": "tsc -p tsconfig-cjs.json",