kysely 0.23.5 → 0.24.1

package/dist/esm/query-builder/on-conflict-builder.js

@@ -2,9 +2,9 @@
 import { ColumnNode } from '../operation-node/column-node.js';
 import { IdentifierNode } from '../operation-node/identifier-node.js';
 import { OnConflictNode } from '../operation-node/on-conflict-node.js';
-import { parseReferentialFilter, parseWhere, } from '../parser/binary-operation-parser.js';
+import { parseReferentialComparison, parseWhere, } from '../parser/binary-operation-parser.js';
 import { parseExists, parseNotExists, } from '../parser/unary-operation-parser.js';
-import { parseUpdateObject, } from '../parser/update-set-parser.js';
+import { parseUpdateExpression, } from '../parser/update-set-parser.js';
 import { freeze } from '../util/object-utils.js';
 import { preventAwait } from '../util/prevent-await.js';
 export class OnConflictBuilder {
@@ -90,9 +90,12 @@ export class OnConflictBuilder {
     whereRef(lhs, op, rhs) {
         return new OnConflictBuilder({
             ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, parseReferentialFilter(lhs, op, rhs)),
+            onConflictNode: OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, parseReferentialComparison(lhs, op, rhs)),
         });
     }
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
     orWhere(...args) {
         return new OnConflictBuilder({
             ...this.#props,
@@ -100,20 +103,16 @@ export class OnConflictBuilder {
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.orWhereRef} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereRef(lhs, op, rhs) {
         return new OnConflictBuilder({
             ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, parseReferentialFilter(lhs, op, rhs)),
+            onConflictNode: OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, parseReferentialComparison(lhs, op, rhs)),
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.whereExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     whereExists(arg) {
         return new OnConflictBuilder({
@@ -122,9 +121,7 @@ export class OnConflictBuilder {
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.whereNotExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     whereNotExists(arg) {
         return new OnConflictBuilder({
@@ -133,9 +130,7 @@ export class OnConflictBuilder {
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.orWhereExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereExists(arg) {
         return new OnConflictBuilder({
@@ -144,9 +139,7 @@ export class OnConflictBuilder {
         });
     }
     /**
-     * Specify an index predicate for the index target.
-     *
-     * See {@link WhereInterface.orWhereNotExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereNotExists(arg) {
         return new OnConflictBuilder({
@@ -214,15 +207,38 @@ export class OnConflictBuilder {
      * on conflict ("pic")
      * do update set "first_name" = $3
      * ```
+     *
+     * In the next example we use the `ref` method to reference
+     * columns of the virtual table `excluded` in a type-safe way
+     * to create an upsert operation:
+     *
+     * ```ts
+     * db.insertInto('person')
+     *   .values(person)
+     *   .onConflict((oc) => oc
+     *     .column('id')
+     *     .doUpdateSet((eb) => ({
+     *       first_name: eb.ref('excluded.first_name'),
+     *       last_name: eb.ref('excluded.last_name')
+     *     }))
+     *   )
+     * ```
      */
-    doUpdateSet(updates) {
+    doUpdateSet(update) {
         return new OnConflictUpdateBuilder({
             ...this.#props,
             onConflictNode: OnConflictNode.cloneWith(this.#props.onConflictNode, {
-                updates: parseUpdateObject(updates),
+                updates: parseUpdateExpression(update),
             }),
         });
     }
+    /**
+     * Simply calls the provided function passing `this` as the only argument. `$call` returns
+     * what the provided function returns.
+     */
+    $call(func) {
+        return func(this);
+    }
 }
 preventAwait(OnConflictBuilder, "don't await OnConflictBuilder instances.");
 export class OnConflictDoNothingBuilder {
@@ -254,9 +270,12 @@ export class OnConflictUpdateBuilder {
     whereRef(lhs, op, rhs) {
         return new OnConflictUpdateBuilder({
             ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, parseReferentialFilter(lhs, op, rhs)),
+            onConflictNode: OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, parseReferentialComparison(lhs, op, rhs)),
         });
     }
+    /**
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
+     */
     orWhere(...args) {
         return new OnConflictUpdateBuilder({
             ...this.#props,
@@ -264,20 +283,16 @@ export class OnConflictUpdateBuilder {
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.orWhereRef} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereRef(lhs, op, rhs) {
         return new OnConflictUpdateBuilder({
             ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, parseReferentialFilter(lhs, op, rhs)),
+            onConflictNode: OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, parseReferentialComparison(lhs, op, rhs)),
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.whereExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     whereExists(arg) {
         return new OnConflictUpdateBuilder({
@@ -286,9 +301,7 @@ export class OnConflictUpdateBuilder {
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.whereNotExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     whereNotExists(arg) {
         return new OnConflictUpdateBuilder({
@@ -297,9 +310,7 @@ export class OnConflictUpdateBuilder {
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.orWhereExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereExists(arg) {
         return new OnConflictUpdateBuilder({
@@ -308,9 +319,7 @@ export class OnConflictUpdateBuilder {
         });
     }
     /**
-     * Specify a where condition for the update operation.
-     *
-     * See {@link WhereInterface.orWhereNotExists} for more info.
+     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
      */
     orWhereNotExists(arg) {
         return new OnConflictUpdateBuilder({
@@ -324,6 +333,13 @@ export class OnConflictUpdateBuilder {
             onConflictNode: OnConflictNode.cloneWithoutUpdateWhere(this.#props.onConflictNode),
         });
     }
+    /**
+     * Simply calls the provided function passing `this` as the only argument. `$call` returns
+     * what the provided function returns.
+     */
+    $call(func) {
+        return func(this);
+    }
     toOperationNode() {
         return this.#props.onConflictNode;
     }

package/dist/esm/query-builder/over-builder.d.ts

@@ -52,6 +52,11 @@ export declare class OverBuilder<DB, TB extends keyof DB> implements OperationNo
      */
     partitionBy(partitionBy: ReadonlyArray<PartitionByExpression<DB, TB>>): OverBuilder<DB, TB>;
     partitionBy(partitionBy: PartitionByExpression<DB, TB>): OverBuilder<DB, TB>;
+    /**
+     * Simply calls the provided function passing `this` as the only argument. `$call` returns
+     * what the provided function returns.
+     */
+    $call<T>(func: (qb: this) => T): T;
     toOperationNode(): OverNode;
 }
 export interface OverBuilderProps {

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

@@ -40,6 +40,13 @@ export class OverBuilder {
             overNode: OverNode.cloneWithPartitionByItems(this.#props.overNode, parsePartitionBy(partitionBy)),
         });
     }
+    /**
+     * Simply calls the provided function passing `this` as the only argument. `$call` returns
+     * what the provided function returns.
+     */
+    $call(func) {
+        return func(this);
+    }
     toOperationNode() {
         return this.#props.overNode;
     }

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

@@ -53,10 +53,10 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
-     *   .returning([
+     *   .returning(eb => [
      *     'id as id',
      *     sql<string>`concat(first_name, ' ', last_name)`.as('full_name'),
-     *     (qb) => qb.selectFrom('pets').select('pet.id').limit(1).as('first_pet_id')
+     *     eb.selectFrom('pets').select('pet.id').limit(1).as('first_pet_id')
      *   ])
      *   .executeTakeFirst()
      * ```