kysely 0.12.2 → 0.15.0

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

@@ -3,18 +3,18 @@ import { CompiledQuery } from '../query-compiler/compiled-query.js';
 import { SelectExpression } from '../parser/select-parser.js';
 import { InsertObject } from '../parser/insert-values-parser.js';
 import { InsertQueryNode } from '../operation-node/insert-query-node.js';
-import { AnyColumn, SingleResultType } from '../util/type-utils.js';
+import { SingleResultType } from '../util/type-utils.js';
 import { MutationObject } from '../parser/update-set-parser.js';
 import { Compilable } from '../util/compilable.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
 import { QueryId } from '../util/query-id.js';
-import { OnConflictConstraintTarget } from '../parser/on-conflict-parser.js';
 import { ParseContext } from '../parser/parse-context.js';
 import { KyselyPlugin } from '../plugin/kysely-plugin.js';
 import { ReturningRow } from '../parser/returning-parser.js';
 import { NoResultErrorConstructor } from './no-result-error.js';
 import { ComplexExpression } from '../parser/complex-expression-parser.js';
 import { ReturningInterface } from './returning-interface.js';
+import { OnConflictBuilder, OnConflictDoNothingBuilder, OnConflictUpdateBuilder } from './on-conflict-builder.js';
 export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements ReturningInterface<DB, TB, O>, OperationNodeSource, Compilable {
     #private;
     constructor(props: InsertQueryBuilderProps);
@@ -23,13 +23,10 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *
      * This method takes an object whose keys are column names and values are
      * values to insert. In addition to the column's type, the values can be
-     * {@link Kysely.raw | raw} instances, select queries or the
-     * {@link Kysely.generated | generated} placeholder.
+     * {@link Kysely.raw | raw} instances or select queries.
      *
-     * You must provide all values defined by the interface of the table you
-     * are inserting into. Values that are generated by the database like auto incrementing
-     * identifiers can be marked with the {@link Kysely.generated} placeholder unless you
-     * want to insert a specific value instead of the generated default.
+     * You must provide all fields you haven't explicitly marked as nullable
+     * or optional using {@link Generated} or {@link ColumnType}.
      *
      * The return value of an `insert` query is an instance of {@link InsertResult}. The
      * {@link InsertResult.insertId | insertId} field holds the auto incremented primary
@@ -48,7 +45,6 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * const id = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -70,11 +66,9 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * await db
      *   .insertInto('person')
      *   .values([{
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   }, {
-     *     id: db.generated,
      *     first_name: 'Arnold',
      *     last_name: 'Schwarzenegger',
      *   }])
@@ -95,7 +89,6 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * const row = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -118,7 +111,6 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * const result = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: db.raw('? || ?', ['Ani', 'ston']),
      *     age: db.selectFrom('person').select(raw('avg(age)')),
@@ -144,7 +136,6 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .select(['id', 'first_name', 'gender'])
      *   .limit(1)
      * ).insertInto('pet').values({
-     *   id: db.generated,
      *   owner_id: (eb) => eb.selectFrom('jennifer').select('id'),
      *   name: (eb) => eb.selectFrom('jennifer').select('first_name'),
      *   species: 'cat',
@@ -196,21 +187,32 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      */
     expression(expression: ComplexExpression<DB, TB>): InsertQueryBuilder<DB, TB, O>;
     /**
-     * Ignores the insert if the column or constraint given as the first
-     * argument conflicts with the current rows in the database. The
-     * default behavior without this method call is to throw an error.
+     * Changes an `insert into` query to an `insert ignore into` query.
      *
-     * For example if a table has a field `name` that has a unique constraint
-     * and you try to insert a row with a `name` that already exists in the
-     * database, calling `onConflictDoNothing('name')` will ignore the conflict
-     * and do nothing. By default the query would throw.
+     * If you use the ignore modifier, ignorable errors that occur while executing the
+     * insert statement are ignored. For example, without ignore, a row that duplicates
+     * an existing unique index or primary key value in the table causes a duplicate-key
+     * error and the statement is aborted. With ignore, the row is discarded and no error
+     * occurs.
      *
-     * Only some dialects like PostgreSQL and SQLite implement the `on conflict`
-     * statement. On MySQL you should use the {@link ignore} method to achieve
-     * similar results.
+     * This is only supported on some dialects like MySQL. On most dialects you should
+     * use the {@link onConflict} method.
      *
-     * Also see the {@link onConflictUpdate} method if you want to perform an
-     * update in case of a conflict (upsert).
+     * ### Examples
+     *
+     * ```ts
+     * await db.insertInto('person')
+     *   .ignore()
+     *   .values(values)
+     *   .execute()
+     * ```
+     */
+    ignore(): InsertQueryBuilder<DB, TB, O>;
+    /**
+     * Adds an `on conflict` clause to the query.
+     *
+     * `on conflict` is only supported by some dialects like PostgreSQL and SQLite. On MySQL
+     * you can use {@link ignore} and {@link onDuplicateKeyUpdate} to achieve similar results.
      *
      * ### Examples
      *
@@ -218,11 +220,13 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * await db
      *   .insertInto('pet')
      *   .values({
-     *     id: db.generated,
      *     name: 'Catto',
      *     species: 'cat',
      *   })
-     *   .onConflictDoNothing('name')
+     *   .onConflict((oc) => oc
+     *     .column('name')
+     *     .doUpdateSet({ species: 'hamster' })
+     *   )
      *   .execute()
      * ```
      *
@@ -231,22 +235,24 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ```sql
      * insert into "pet" ("name", "species")
      * values ($1, $2)
-     * on conflict ("name") do nothing
+     * on conflict ("name")
+     * do update set "species" = $3
      * ```
      *
-     * You can provide the name of the constraint instead of a column name
+     * You can provide the name of the constraint instead of a column name:
      *
      * ```ts
      * await db
      *   .insertInto('pet')
      *   .values({
-     *     id: db.generated,
      *     name: 'Catto',
      *     species: 'cat',
      *   })
-     *   .onConflictDoNothing({
-     *     constraint: 'pet_name_key'
-     *   })
+     *   .onConflict((oc) => oc
+     *     .constraint('pet_name_key')
+     *     .doUpdateSet({ species: 'hamster' })
+     *   )
+     *   .execute()
      *   .execute()
      * ```
      *
@@ -256,66 +262,49 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * insert into "pet" ("name", "species")
      * values ($1, $2)
      * on conflict on constraint "pet_name_key"
-     * do nothing
+     * do update set "species" = $3
      * ```
-     */
-    onConflictDoNothing(column: AnyColumn<DB, TB>): InsertQueryBuilder<DB, TB, O>;
-    onConflictDoNothing(columns: ReadonlyArray<AnyColumn<DB, TB>>): InsertQueryBuilder<DB, TB, O>;
-    onConflictDoNothing(constraint: OnConflictConstraintTarget): InsertQueryBuilder<DB, TB, O>;
-    /**
-     * Changes an `insert into` query to an `insert ignore into` query.
      *
-     * If you use the ignore modifier, ignorable errors that occur while executing the
-     * insert statement are ignored. For example, without ignore, a row that duplicates
-     * an existing unique index or primary key value in the table causes a duplicate-key
-     * error and the statement is aborted. With ignore, the row is discarded and no error
-     * occurs.
-     *
-     * This is only supported on some dialects like MySQL. On most dialects you should
-     * use the {@link onConflictDoNothing} method.
-     *
-     * ### Examples
+     * You can also specify an expression as the conflict target in case
+     * the unique index is an expression index:
      *
      * ```ts
-     * await db.insertInto('person')
-     *   .ignore()
-     *   .values(values)
+     * await db
+     *   .insertInto('pet')
+     *   .values({
+     *     name: 'Catto',
+     *     species: 'cat',
+     *   })
+     *   .onConflict((oc) => oc
+     *     .expression(db.raw('lower(name)'))
+     *     .doUpdateSet({ species: 'hamster' })
+     *   )
      *   .execute()
      * ```
-     */
-    ignore(): InsertQueryBuilder<DB, TB, O>;
-    /**
-     * Ignores an insert if the column or constraint given as the first
-     * argument conflicts with the current rows in the database and
-     * performs an update on the conflicting row instead. This method
-     * can be used to implement an upsert operation.
-     *
-     * For example if a table has a field `name` that has a unique constraint
-     * and you try to insert a row with a `name` that already exists in the
-     * database, calling `onConfictUpdate('name', { species: 'hamster' })`
-     * will set the conflicting row's `species` field to value `'hamster'`.
-     * By default the query would throw.
-     *
-     * The second argument (updates) can be anything the {@link UpdateQueryBuilder.set | set}
-     * method accepts.
      *
-     * The `on conflict do update` statement is only implemented by some dialects
-     * like PostgreSQL and SQLite. On MySQL you should use the {@link onDuplicateKeyUpdate}
-     * method instead.
+     * The generated SQL (PostgreSQL):
      *
-     * Also see the {@link onConflictDoNothing} method.
+     * ```sql
+     * insert into "pet" ("name", "species")
+     * values ($1, $2)
+     * on conflict (lower(name))
+     * do update set "species" = $3
+     * ```
      *
-     * ### Examples
+     * You can add a filter for the update statement like this:
      *
      * ```ts
      * await db
      *   .insertInto('pet')
      *   .values({
-     *     id: db.generated,
      *     name: 'Catto',
      *     species: 'cat',
      *   })
-     *   .onConflictUpdate('name', { species: 'hamster' })
+     *   .onConflict((oc) => oc
+     *     .column('name')
+     *     .doUpdateSet({ species: 'hamster' })
+     *     .where('excluded.name', '!=', 'Catto'')
+     *   )
      *   .execute()
      * ```
      *
@@ -324,22 +313,23 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ```sql
      * insert into "pet" ("name", "species")
      * values ($1, $2)
-     * on conflict ("name") do update set "species" = $3
+     * on conflict ("name")
+     * do update set "species" = $3
+     * where "excluded"."name" != $4
      * ```
      *
-     * You can provied the name of the constraint instead of a column name
+     * You can create an `on conflict do nothing` clauses like this:
      *
      * ```ts
      * await db
      *   .insertInto('pet')
      *   .values({
-     *     id: db.generated,
      *     name: 'Catto',
      *     species: 'cat',
      *   })
-     *   .onConflictUpdate(
-     *     { constraint: 'pet_name_key' },
-     *     { species: 'hamster' }
+     *   .onConflict((oc) => oc
+     *     .column('name')
+     *     .doNothing()
      *   )
      *   .execute()
      * ```
@@ -349,13 +339,10 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ```sql
      * insert into "pet" ("name", "species")
      * values ($1, $2)
-     * on conflict on constraint "pet_name_key"
-     * do update set "species" = $3
+     * on conflict ("name") do nothing
      * ```
      */
-    onConflictUpdate(column: AnyColumn<DB, TB>, updates: MutationObject<DB, TB>): InsertQueryBuilder<DB, TB, O>;
-    onConflictUpdate(columns: ReadonlyArray<AnyColumn<DB, TB>>, updates: MutationObject<DB, TB>): InsertQueryBuilder<DB, TB, O>;
-    onConflictUpdate(constraint: OnConflictConstraintTarget, updates: MutationObject<DB, TB>): InsertQueryBuilder<DB, TB, O>;
+    onConflict(callback: (builder: OnConflictBuilder<DB, TB>) => OnConflictDoNothingBuilder<DB, TB> | OnConflictUpdateBuilder<DB, TB>): InsertQueryBuilder<DB, TB, O>;
     /**
      * Adds `on duplicate key update` to the query.
      *
@@ -363,7 +350,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * a duplicate value in a unique index or primary key, an update of the old row occurs.
      *
      * This is only implemented by some dialects like MySQL. On most dialects you should
-     * use {@link onConflictUpdate} instead.
+     * use {@link onConflict} instead.
      *
      * ### Examples
      *
@@ -395,7 +382,6 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * const { id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -409,7 +395,6 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * const { id, first_name } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -425,7 +410,6 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * const { id, full_name, first_pet_id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -456,9 +440,9 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .selectAll()
      *   .call((qb) => {
      *     if (something) {
-     *       return qb.onConflictDoNothing('something')
+     *       return qb.onConflict((oc) => oc.column('something').doNothing())
      *     } else {
-     *       return qb.onConflictDoNothing('something_else')
+     *       return qb.onConflict((oc) => oc.column('something_else').doNothing())
      *     }
      *   })
      *   .execute()

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

@@ -4,13 +4,14 @@ import { InsertQueryNode } from '../operation-node/insert-query-node.js';
 import { QueryNode } from '../operation-node/query-node.js';
 import { parseUpdateObject, } from '../parser/update-set-parser.js';
 import { preventAwait } from '../util/prevent-await.js';
-import { parseOnConflictDoNothing, parseOnConflictUpdate, } from '../parser/on-conflict-parser.js';
 import { freeze } from '../util/object-utils.js';
 import { OnDuplicateKeyNode } from '../operation-node/on-duplicate-key-node.js';
 import { InsertResult } from './insert-result.js';
 import { NoResultError } from './no-result-error.js';
 import { parseComplexExpression, } from '../parser/complex-expression-parser.js';
 import { ColumnNode } from '../operation-node/column-node.js';
+import { OnConflictBuilder, } from './on-conflict-builder.js';
+import { OnConflictNode } from '../operation-node/on-conflict-node.js';
 export class InsertQueryBuilder {
     #props;
     constructor(props) {
@@ -82,14 +83,6 @@ export class InsertQueryBuilder {
             }),
         });
     }
-    onConflictDoNothing(target) {
-        return new InsertQueryBuilder({
-            ...this.#props,
-            queryNode: InsertQueryNode.cloneWith(this.#props.queryNode, {
-                onConflict: parseOnConflictDoNothing(target),
-            }),
-        });
-    }
     /**
      * Changes an `insert into` query to an `insert ignore into` query.
      *
@@ -100,7 +93,7 @@ export class InsertQueryBuilder {
      * occurs.
      *
      * This is only supported on some dialects like MySQL. On most dialects you should
-     * use the {@link onConflictDoNothing} method.
+     * use the {@link onConflict} method.
      *
      * ### Examples
      *
@@ -119,11 +112,148 @@ export class InsertQueryBuilder {
             }),
         });
     }
-    onConflictUpdate(target, updates) {
+    /**
+     * Adds an `on conflict` clause to the query.
+     *
+     * `on conflict` is only supported by some dialects like PostgreSQL and SQLite. On MySQL
+     * you can use {@link ignore} and {@link onDuplicateKeyUpdate} to achieve similar results.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db
+     *   .insertInto('pet')
+     *   .values({
+     *     name: 'Catto',
+     *     species: 'cat',
+     *   })
+     *   .onConflict((oc) => oc
+     *     .column('name')
+     *     .doUpdateSet({ species: 'hamster' })
+     *   )
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "pet" ("name", "species")
+     * values ($1, $2)
+     * on conflict ("name")
+     * do update set "species" = $3
+     * ```
+     *
+     * You can provide the name of the constraint instead of a column name:
+     *
+     * ```ts
+     * await db
+     *   .insertInto('pet')
+     *   .values({
+     *     name: 'Catto',
+     *     species: 'cat',
+     *   })
+     *   .onConflict((oc) => oc
+     *     .constraint('pet_name_key')
+     *     .doUpdateSet({ species: 'hamster' })
+     *   )
+     *   .execute()
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "pet" ("name", "species")
+     * values ($1, $2)
+     * on conflict on constraint "pet_name_key"
+     * do update set "species" = $3
+     * ```
+     *
+     * You can also specify an expression as the conflict target in case
+     * the unique index is an expression index:
+     *
+     * ```ts
+     * await db
+     *   .insertInto('pet')
+     *   .values({
+     *     name: 'Catto',
+     *     species: 'cat',
+     *   })
+     *   .onConflict((oc) => oc
+     *     .expression(db.raw('lower(name)'))
+     *     .doUpdateSet({ species: 'hamster' })
+     *   )
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "pet" ("name", "species")
+     * values ($1, $2)
+     * on conflict (lower(name))
+     * do update set "species" = $3
+     * ```
+     *
+     * You can add a filter for the update statement like this:
+     *
+     * ```ts
+     * await db
+     *   .insertInto('pet')
+     *   .values({
+     *     name: 'Catto',
+     *     species: 'cat',
+     *   })
+     *   .onConflict((oc) => oc
+     *     .column('name')
+     *     .doUpdateSet({ species: 'hamster' })
+     *     .where('excluded.name', '!=', 'Catto'')
+     *   )
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "pet" ("name", "species")
+     * values ($1, $2)
+     * on conflict ("name")
+     * do update set "species" = $3
+     * where "excluded"."name" != $4
+     * ```
+     *
+     * You can create an `on conflict do nothing` clauses like this:
+     *
+     * ```ts
+     * await db
+     *   .insertInto('pet')
+     *   .values({
+     *     name: 'Catto',
+     *     species: 'cat',
+     *   })
+     *   .onConflict((oc) => oc
+     *     .column('name')
+     *     .doNothing()
+     *   )
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "pet" ("name", "species")
+     * values ($1, $2)
+     * on conflict ("name") do nothing
+     * ```
+     */
+    onConflict(callback) {
         return new InsertQueryBuilder({
             ...this.#props,
             queryNode: InsertQueryNode.cloneWith(this.#props.queryNode, {
-                onConflict: parseOnConflictUpdate(this.#props.parseContext, target, updates),
+                onConflict: callback(new OnConflictBuilder({
+                    onConflictNode: OnConflictNode.create(),
+                    parseContext: this.#props.parseContext,
+                })).toOperationNode(),
             }),
         });
     }
@@ -134,7 +264,7 @@ export class InsertQueryBuilder {
      * a duplicate value in a unique index or primary key, an update of the old row occurs.
      *
      * This is only implemented by some dialects like MySQL. On most dialects you should
-     * use {@link onConflictUpdate} instead.
+     * use {@link onConflict} instead.
      *
      * ### Examples
      *
@@ -177,9 +307,9 @@ export class InsertQueryBuilder {
      *   .selectAll()
      *   .call((qb) => {
      *     if (something) {
-     *       return qb.onConflictDoNothing('something')
+     *       return qb.onConflict((oc) => oc.column('something').doNothing())
      *     } else {
-     *       return qb.onConflictDoNothing('something_else')
+     *       return qb.onConflict((oc) => oc.column('something_else').doNothing())
      *     }
      *   })
      *   .execute()