kysely 0.12.0 → 0.14.0

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

@@ -0,0 +1,323 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnConflictUpdateBuilder = exports.OnConflictDoNothingBuilder = exports.OnConflictBuilder = void 0;
+const column_node_js_1 = require("../operation-node/column-node.js");
+const identifier_node_js_1 = require("../operation-node/identifier-node.js");
+const on_conflict_node_js_1 = require("../operation-node/on-conflict-node.js");
+const filter_parser_js_1 = require("../parser/filter-parser.js");
+const update_set_parser_js_1 = require("../parser/update-set-parser.js");
+const object_utils_js_1 = require("../util/object-utils.js");
+const prevent_await_js_1 = require("../util/prevent-await.js");
+class OnConflictBuilder {
+    #props;
+    constructor(props) {
+        this.#props = (0, object_utils_js_1.freeze)(props);
+    }
+    /**
+     * Specify a single column as the conflict target.
+     *
+     * Also see the {@link columns}, {@link constraint} and {@link expression}
+     * methods for alternative ways to specify the conflict target.
+     */
+    column(column) {
+        const columnNode = column_node_js_1.ColumnNode.create(column);
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWith(this.#props.onConflictNode, {
+                columns: this.#props.onConflictNode.columns
+                    ? (0, object_utils_js_1.freeze)([...this.#props.onConflictNode.columns, columnNode])
+                    : (0, object_utils_js_1.freeze)([columnNode]),
+            }),
+        });
+    }
+    /**
+     * Specify a list of columns as the conflict target.
+     *
+     * Also see the {@link column}, {@link constraint} and {@link expression}
+     * methods for alternative ways to specify the conflict target.
+     */
+    columns(columns) {
+        const columnNodes = columns.map(column_node_js_1.ColumnNode.create);
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWith(this.#props.onConflictNode, {
+                columns: this.#props.onConflictNode.columns
+                    ? (0, object_utils_js_1.freeze)([...this.#props.onConflictNode.columns, ...columnNodes])
+                    : (0, object_utils_js_1.freeze)(columnNodes),
+            }),
+        });
+    }
+    /**
+     * Specify a specific constraint by name as the conflict target.
+     *
+     * Also see the {@link column}, {@link columns} and {@link expression}
+     * methods for alternative ways to specify the conflict target.
+     */
+    constraint(constraintName) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWith(this.#props.onConflictNode, {
+                constraint: identifier_node_js_1.IdentifierNode.create(constraintName),
+            }),
+        });
+    }
+    /**
+     * Specify an expression as the conflict target.
+     *
+     * This can be used if the unique index is an expression index.
+     *
+     * Also see the {@link column}, {@link columns} and {@link constraint}
+     * methods for alternative ways to specify the conflict target.
+     */
+    expression(expression) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWith(this.#props.onConflictNode, {
+                indexExpression: expression.toOperationNode(),
+            }),
+        });
+    }
+    where(...args) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseWhereFilter)(this.#props.parseContext, args)),
+        });
+    }
+    /**
+     * Specify an index predicate for the index target.
+     *
+     * See {@link WhereInterface.whereRef} for more info.
+     */
+    whereRef(lhs, op, rhs) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseReferenceFilter)(this.#props.parseContext, lhs, op, rhs)),
+        });
+    }
+    orWhere(...args) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseWhereFilter)(this.#props.parseContext, args)),
+        });
+    }
+    /**
+     * Specify an index predicate for the index target.
+     *
+     * See {@link WhereInterface.orWhereRef} for more info.
+     */
+    orWhereRef(lhs, op, rhs) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseReferenceFilter)(this.#props.parseContext, lhs, op, rhs)),
+        });
+    }
+    /**
+     * Specify an index predicate for the index target.
+     *
+     * See {@link WhereInterface.whereExists} for more info.
+     */
+    whereExists(arg) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseExistFilter)(this.#props.parseContext, arg)),
+        });
+    }
+    /**
+     * Specify an index predicate for the index target.
+     *
+     * See {@link WhereInterface.whereNotExists} for more info.
+     */
+    whereNotExists(arg) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseNotExistFilter)(this.#props.parseContext, arg)),
+        });
+    }
+    /**
+     * Specify an index predicate for the index target.
+     *
+     * See {@link WhereInterface.orWhereExists} for more info.
+     */
+    orWhereExists(arg) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseExistFilter)(this.#props.parseContext, arg)),
+        });
+    }
+    /**
+     * Specify an index predicate for the index target.
+     *
+     * See {@link WhereInterface.orWhereNotExists} for more info.
+     */
+    orWhereNotExists(arg) {
+        return new OnConflictBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseNotExistFilter)(this.#props.parseContext, arg)),
+        });
+    }
+    /**
+     * Adds the "do nothing" conflict action.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db
+     *   .insertInto('person')
+     *   .values({ id: db.generated, first_name, pic })
+     *   .onConflict((oc) => oc
+     *     .column('pic')
+     *     .doNothing()
+     *   )
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "person" ("first_name", "pic")
+     * values ($1, $2)
+     * on conflict ("pic") do nothing
+     * ```
+     */
+    doNothing() {
+        return new OnConflictDoNothingBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWith(this.#props.onConflictNode, {
+                doNothing: true,
+            }),
+        });
+    }
+    /**
+     * Adds the "do update set" conflict action.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db
+     *   .insertInto('person')
+     *   .values({ id: db.generated, first_name, pic })
+     *   .onConflict((oc) => oc
+     *     .column('pic')
+     *     .doUpdateSet({ first_name })
+     *   )
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "person" ("first_name", "pic")
+     * values ($1, $2)
+     * on conflict ("pic")
+     * do update set "first_name" = $3
+     * ```
+     */
+    doUpdateSet(updates) {
+        return new OnConflictUpdateBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWith(this.#props.onConflictNode, {
+                updates: (0, update_set_parser_js_1.parseUpdateObject)(this.#props.parseContext, updates),
+            }),
+        });
+    }
+}
+exports.OnConflictBuilder = OnConflictBuilder;
+(0, prevent_await_js_1.preventAwait)(OnConflictBuilder, "don't await OnConflictBuilder instances.");
+class OnConflictDoNothingBuilder {
+    #props;
+    constructor(props) {
+        this.#props = (0, object_utils_js_1.freeze)(props);
+    }
+    toOperationNode() {
+        return this.#props.onConflictNode;
+    }
+}
+exports.OnConflictDoNothingBuilder = OnConflictDoNothingBuilder;
+(0, prevent_await_js_1.preventAwait)(OnConflictDoNothingBuilder, "don't await OnConflictDoNothingBuilder instances.");
+class OnConflictUpdateBuilder {
+    #props;
+    constructor(props) {
+        this.#props = (0, object_utils_js_1.freeze)(props);
+    }
+    where(...args) {
+        return new OnConflictUpdateBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseWhereFilter)(this.#props.parseContext, args)),
+        });
+    }
+    /**
+     * Specify a where condition for the update operation.
+     *
+     * See {@link WhereInterface.whereRef} for more info.
+     */
+    whereRef(lhs, op, rhs) {
+        return new OnConflictUpdateBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseReferenceFilter)(this.#props.parseContext, lhs, op, rhs)),
+        });
+    }
+    orWhere(...args) {
+        return new OnConflictUpdateBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseWhereFilter)(this.#props.parseContext, args)),
+        });
+    }
+    /**
+     * Specify a where condition for the update operation.
+     *
+     * See {@link WhereInterface.orWhereRef} for more info.
+     */
+    orWhereRef(lhs, op, rhs) {
+        return new OnConflictUpdateBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseReferenceFilter)(this.#props.parseContext, lhs, op, rhs)),
+        });
+    }
+    /**
+     * Specify a where condition for the update operation.
+     *
+     * See {@link WhereInterface.whereExists} for more info.
+     */
+    whereExists(arg) {
+        return new OnConflictUpdateBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseExistFilter)(this.#props.parseContext, arg)),
+        });
+    }
+    /**
+     * Specify a where condition for the update operation.
+     *
+     * See {@link WhereInterface.whereNotExists} for more info.
+     */
+    whereNotExists(arg) {
+        return new OnConflictUpdateBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseNotExistFilter)(this.#props.parseContext, arg)),
+        });
+    }
+    /**
+     * Specify a where condition for the update operation.
+     *
+     * See {@link WhereInterface.orWhereExists} for more info.
+     */
+    orWhereExists(arg) {
+        return new OnConflictUpdateBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseExistFilter)(this.#props.parseContext, arg)),
+        });
+    }
+    /**
+     * Specify a where condition for the update operation.
+     *
+     * See {@link WhereInterface.orWhereNotExists} for more info.
+     */
+    orWhereNotExists(arg) {
+        return new OnConflictUpdateBuilder({
+            ...this.#props,
+            onConflictNode: on_conflict_node_js_1.OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, (0, filter_parser_js_1.parseNotExistFilter)(this.#props.parseContext, arg)),
+        });
+    }
+    toOperationNode() {
+        return this.#props.onConflictNode;
+    }
+}
+exports.OnConflictUpdateBuilder = OnConflictUpdateBuilder;
+(0, prevent_await_js_1.preventAwait)(OnConflictUpdateBuilder, "don't await OnConflictUpdateBuilder instances.");

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

@@ -11,7 +11,7 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      * [this bug](https://sqlite.org/forum/forumpost/033daf0b32) in SQLite.
      * For example `.returning('id as id')`.
      *
-     * Also see the {@link ReturningInterface.returningAll | returningAll} method.
+     * Also see the {@link returningAll} method.
      *
      * ### Examples
      *