kysely 0.27.4 → 0.27.6

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

@@ -144,7 +144,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .insertInto('person')
      *   .values(({ ref, selectFrom, fn }) => ({
      *     first_name: 'Jennifer',
-     *     last_name: sql<string>`>concat(${ani}, ${ston})`,
+     *     last_name: sql<string>`concat(${ani}, ${ston})`,
      *     middle_name: ref('first_name'),
      *     age: selectFrom('person')
      *       .select(fn.avg<number>('age').as('avg_age')),
@@ -172,7 +172,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * You can also use the callback version of subqueries or raw expressions:
      *
      * ```ts
-     * db.with('jennifer', (db) => db
+     * await db.with('jennifer', (db) => db
      *   .selectFrom('person')
      *   .where('first_name', '=', 'Jennifer')
      *   .select(['id', 'first_name', 'gender'])
@@ -182,6 +182,24 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   name: eb.selectFrom('jennifer').select('first_name'),
      *   species: 'cat',
      * }))
+     * .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * with "jennifer" as (
+     *   select "id", "first_name", "gender"
+     *   from "person"
+     *   where "first_name" = $1
+     *   limit $2
+     * )
+     * insert into "pet" ("owner_id", "name", "species")
+     * values (
+     *  (select "id" from "jennifer"),
+     *  (select "first_name" from "jennifer"),
+     *  $3
+     * )
      * ```
      */
     values(insert: InsertExpression<DB, TB>): InsertQueryBuilder<DB, TB, O>;
@@ -195,9 +213,10 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ### Examples
      *
      * ```ts
-     * db.insertInto('person')
+     * await db.insertInto('person')
      *   .columns(['first_name'])
      *   .expression((eb) => eb.selectFrom('pet').select('pet.name'))
+     *   .execute()
      * ```
      *
      * The generated SQL (PostgreSQL):
@@ -251,8 +270,40 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .defaultValues()
      *   .execute()
      * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "person" default values
+     * ```
      */
     defaultValues(): InsertQueryBuilder<DB, TB, O>;
+    /**
+     * This can be used to add any additional SQL to the end of the query.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * import { sql } from 'kysely'
+     *
+     * await db.insertInto('person')
+     *   .values({
+     *     first_name: 'John',
+     *     last_name: 'Doe',
+     *     gender: 'male',
+     *   })
+     *   .modifyEnd(sql`-- This is a comment`)
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * insert into `person` ("first_name", "last_name", "gender")
+     * values (?, ?, ?) -- This is a comment
+     * ```
+     */
+    modifyEnd(modifier: Expression<any>): InsertQueryBuilder<DB, TB, O>;
     /**
      * Changes an `insert into` query to an `insert ignore into` query.
      *
@@ -270,9 +321,19 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ```ts
      * await db.insertInto('person')
      *   .ignore()
-     *   .values(values)
+     *   .values({
+     *     first_name: 'John',
+     *     last_name: 'Doe',
+     *     gender: 'female',
+     *   })
      *   .execute()
      * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * insert ignore into `person` ("first_name", "last_name", "gender") values (?, ?, ?)
+     * ```
      */
     ignore(): InsertQueryBuilder<DB, TB, O>;
     /**
@@ -285,6 +346,8 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * Insert the first 5 rows:
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * await db.insertInto('person')
      *   .top(5)
      *   .columns(['first_name', 'gender'])
@@ -303,6 +366,8 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * Insert the first 50 percent of rows:
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * await db.insertInto('person')
      *   .top(50, 'percent')
      *   .columns(['first_name', 'gender'])
@@ -333,6 +398,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .values({
      *     name: 'Catto',
      *     species: 'cat',
+     *     owner_id: 3,
      *   })
      *   .onConflict((oc) => oc
      *     .column('name')
@@ -344,10 +410,10 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * The generated SQL (PostgreSQL):
      *
      * ```sql
-     * insert into "pet" ("name", "species")
-     * values ($1, $2)
+     * insert into "pet" ("name", "species", "owner_id")
+     * values ($1, $2, $3)
      * on conflict ("name")
-     * do update set "species" = $3
+     * do update set "species" = $4
      * ```
      *
      * You can provide the name of the constraint instead of a column name:
@@ -358,6 +424,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .values({
      *     name: 'Catto',
      *     species: 'cat',
+     *     owner_id: 3,
      *   })
      *   .onConflict((oc) => oc
      *     .constraint('pet_name_key')
@@ -369,10 +436,10 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * The generated SQL (PostgreSQL):
      *
      * ```sql
-     * insert into "pet" ("name", "species")
-     * values ($1, $2)
+     * insert into "pet" ("name", "species", "owner_id")
+     * values ($1, $2, $3)
      * on conflict on constraint "pet_name_key"
-     * do update set "species" = $3
+     * do update set "species" = $4
      * ```
      *
      * You can also specify an expression as the conflict target in case
@@ -386,6 +453,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .values({
      *     name: 'Catto',
      *     species: 'cat',
+     *     owner_id: 3,
      *   })
      *   .onConflict((oc) => oc
      *     .expression(sql<string>`lower(name)`)
@@ -397,10 +465,10 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * The generated SQL (PostgreSQL):
      *
      * ```sql
-     * insert into "pet" ("name", "species")
-     * values ($1, $2)
+     * insert into "pet" ("name", "species", "owner_id")
+     * values ($1, $2, $3)
      * on conflict (lower(name))
-     * do update set "species" = $3
+     * do update set "species" = $4
      * ```
      *
      * You can add a filter for the update statement like this:
@@ -411,11 +479,12 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .values({
      *     name: 'Catto',
      *     species: 'cat',
+     *     owner_id: 3,
      *   })
      *   .onConflict((oc) => oc
      *     .column('name')
      *     .doUpdateSet({ species: 'hamster' })
-     *     .where('excluded.name', '!=', 'Catto'')
+     *     .where('excluded.name', '!=', 'Catto')
      *   )
      *   .execute()
      * ```
@@ -423,11 +492,11 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * The generated SQL (PostgreSQL):
      *
      * ```sql
-     * insert into "pet" ("name", "species")
-     * values ($1, $2)
+     * insert into "pet" ("name", "species", "owner_id")
+     * values ($1, $2, $3)
      * on conflict ("name")
-     * do update set "species" = $3
-     * where "excluded"."name" != $4
+     * do update set "species" = $4
+     * where "excluded"."name" != $5
      * ```
      *
      * You can create an `on conflict do nothing` clauses like this:
@@ -438,6 +507,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .values({
      *     name: 'Catto',
      *     species: 'cat',
+     *     owner_id: 3,
      *   })
      *   .onConflict((oc) => oc
      *     .column('name')
@@ -449,8 +519,8 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * The generated SQL (PostgreSQL):
      *
      * ```sql
-     * insert into "pet" ("name", "species")
-     * values ($1, $2)
+     * insert into "pet" ("name", "species", "owner_id")
+     * values ($1, $2, $3)
      * on conflict ("name") do nothing
      * ```
      *
@@ -459,8 +529,13 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * `ExpressionBuilder`:
      *
      * ```ts
-     * db.insertInto('person')
-     *   .values(person)
+     * await db.insertInto('person')
+     *   .values({
+     *     id: 1,
+     *     first_name: 'John',
+     *     last_name: 'Doe',
+     *     gender: 'male',
+     *   })
      *   .onConflict(oc => oc
      *     .column('id')
      *     .doUpdateSet({
@@ -468,6 +543,18 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *       last_name: (eb) => eb.ref('excluded.last_name')
      *     })
      *   )
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "person" ("id", "first_name", "last_name", "gender")
+     * values ($1, $2, $3, $4)
+     * on conflict ("id")
+     * do update set
+     *  "first_name" = "excluded"."first_name",
+     *  "last_name" = "excluded"."last_name"
      * ```
      */
     onConflict(callback: (builder: OnConflictBuilder<DB, TB>) => OnConflictUpdateBuilder<OnConflictDatabase<DB, TB>, OnConflictTables<TB>> | OnConflictDoNothingBuilder<DB, TB>): InsertQueryBuilder<DB, TB, O>;
@@ -485,8 +572,22 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ```ts
      * await db
      *   .insertInto('person')
-     *   .values(values)
-     *   .onDuplicateKeyUpdate({ species: 'hamster' })
+     *   .values({
+     *     id: 1,
+     *     first_name: 'John',
+     *     last_name: 'Doe',
+     *     gender: 'male',
+     *   })
+     *   .onDuplicateKeyUpdate({ updated_at: new Date().toISOString() })
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * insert into `person` (`id`, `first_name`, `last_name`, `gender`)
+     * values (?, ?, ?, ?)
+     * on duplicate key update `updated_at` = ?
      * ```
      */
     onDuplicateKeyUpdate(update: UpdateObjectExpression<DB, TB, TB>): InsertQueryBuilder<DB, TB, O>;
@@ -514,20 +615,20 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *     last_name: 'Aniston'
      *   })
      *   .returning('id')
-     *   .executeTakeFirst()
+     *   .executeTakeFirstOrThrow()
      * ```
      *
      * Return multiple columns:
      *
      * ```ts
-     * const { id, first_name } = await db
+     * const { id, last_name } = await db
      *   .insertInto('person')
      *   .values({
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
      *   .returning(['id', 'last_name'])
-     *   .executeTakeFirst()
+     *   .executeTakeFirstOrThrow()
      * ```
      *
      * Return arbitrary expressions:
@@ -544,9 +645,9 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .returning((eb) => [
      *     'id as id',
      *     sql<string>`concat(first_name, ' ', last_name)`.as('full_name'),
-     *     eb.selectFrom('pets').select('pet.id').limit(1).as('first_pet_id')
+     *     eb.selectFrom('pet').select('pet.id').limit(1).as('first_pet_id')
      *   ])
-     *   .executeTakeFirst()
+     *   .executeTakeFirstOrThrow()
      * ```
      */
     returning<SE extends SelectExpression<DB, TB>>(selections: ReadonlyArray<SE>): InsertQueryBuilder<DB, TB, ReturningRow<DB, TB, O, SE>>;
@@ -577,15 +678,24 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *   .output('inserted.id')
      *   .values({
      *     first_name: 'Jennifer',
-     *     last_name: 'Aniston'
+     *     last_name: 'Aniston',
+     *     gender: 'female',
      *   })
-     *   .executeTakeFirst()
+     *   .executeTakeFirstOrThrow()
+     * ```
+     *
+     * The generated SQL (MSSQL):
+     *
+     * ```sql
+     * insert into "person" ("first_name", "last_name", "gender")
+     * output "inserted"."id"
+     * values (@1, @2, @3)
      * ```
      *
      * Return multiple columns:
      *
      * ```ts
-     * const { id, first_name } = await db
+     * const { old_first_name, old_last_name, new_first_name, new_last_name } = await db
      *   .updateTable('person')
      *   .set({ first_name: 'John', last_name: 'Doe' })
      *   .output([
@@ -595,7 +705,19 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *     'inserted.last_name as new_last_name',
      *   ])
      *   .where('created_at', '<', new Date())
-     *   .executeTakeFirst()
+     *   .executeTakeFirstOrThrow()
+     * ```
+     *
+     * The generated SQL (MSSQL):
+     *
+     * ```sql
+     * update "person"
+     * set "first_name" = @1, "last_name" = @2
+     * output "deleted"."first_name" as "old_first_name",
+     *   "deleted"."last_name" as "old_last_name",
+     *   "inserted"."first_name" as "new_first_name",
+     *   "inserted"."last_name" as "new_last_name"
+     * where "created_at" < @3
      * ```
      *
      * Return arbitrary expressions:
@@ -603,11 +725,19 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ```ts
      * import { sql } from 'kysely'
      *
-     * const { id, full_name } = await db
+     * const { full_name } = await db
      *   .deleteFrom('person')
-     *   .output((eb) => sql<string>`concat(${eb.ref('deleted.first_name')}, ' ', ${eb.ref('deleted.last_name')})`.as('full_name')
+     *   .output((eb) => sql<string>`concat(${eb.ref('deleted.first_name')}, ' ', ${eb.ref('deleted.last_name')})`.as('full_name'))
      *   .where('created_at', '<', new Date())
-     *   .executeTakeFirst()
+     *   .executeTakeFirstOrThrow()
+     * ```
+     *
+     * The generated SQL (MSSQL):
+     *
+     * ```sql
+     * delete from "person"
+     * output concat("deleted"."first_name", ' ', "deleted"."last_name") as "full_name"
+     * where "created_at" < @1
      * ```
      *
      * Return the action performed on the row:
@@ -628,7 +758,21 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      *     'inserted.id as inserted_id',
      *     'deleted.id as deleted_id',
      *   ])
+     *   .execute()
      * ```
+     *
+     * The generated SQL (MSSQL):
+     *
+     * ```sql
+     * merge into "person"
+     * using "pet" on "pet"."owner_id" = "person"."id"
+     * when matched then delete
+     * when not matched then
+     * insert ("first_name", "last_name", "gender")
+     * values (@1, @2, @3)
+     * output "inserted"."id" as "inserted_id", "deleted"."id" as "deleted_id"
+     * ```
+     *
      */
     output<OE extends OutputExpression<DB, TB, 'inserted'>>(selections: readonly OE[]): InsertQueryBuilder<DB, TB, ReturningRow<DB, TB, O, SelectExpressionFromOutputExpression<OE>>>;
     output<CB extends OutputCallback<DB, TB, 'inserted'>>(callback: CB): InsertQueryBuilder<DB, TB, ReturningRow<DB, TB, O, SelectExpressionFromOutputCallback<CB>>>;
@@ -646,16 +790,17 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ### Examples
      *
      * ```ts
-     * db.insertInto('person')
-     *   .values({ first_name: 'James', last_name: 'Smith', age: 42 })
+     * await db.insertInto('person')
+     *   .values({ first_name: 'James', last_name: 'Smith', gender: 'male' })
      *   .returning(['first_name'])
      *   .clearReturning()
+     *   .execute()
      * ```
      *
      * The generated SQL(PostgreSQL):
      *
      * ```sql
-     * insert into "person" ("James", "Smith", 42)
+     * insert into "person" ("first_name", "last_name", "gender") values ($1, $2, $3)
      * ```
      */
     clearReturning(): InsertQueryBuilder<DB, TB, InsertResult>;
@@ -671,13 +816,15 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * The next example uses a helper function `log` to log a query:
      *
      * ```ts
+     * import type { Compilable } from 'kysely'
+     *
      * function log<T extends Compilable>(qb: T): T {
      *   console.log(qb.compile())
      *   return qb
      * }
      *
-     * db.updateTable('person')
-     *   .set(values)
+     * await db.insertInto('person')
+     *   .values({ first_name: 'John', last_name: 'Doe', gender: 'male' })
      *   .$call(log)
      *   .execute()
      * ```
@@ -696,7 +843,9 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ### Examples
      *
      * ```ts
-     * async function insertPerson(values: InsertablePerson, returnLastName: boolean) {
+     * import type { NewPerson } from 'type-editor' // imaginary module
+     *
+     * async function insertPerson(values: NewPerson, returnLastName: boolean) {
      *   return await db
      *     .insertInto('person')
      *     .values(values)
@@ -711,11 +860,11 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * the code. In the example above the return type of the `insertPerson` function is:
      *
      * ```ts
-     * {
+     * Promise<{
      *   id: number
      *   first_name: string
      *   last_name?: string
-     * }
+     * }>
      * ```
      */
     $if<O2>(condition: boolean, func: (qb: this) => InsertQueryBuilder<any, any, O2>): O2 extends InsertResult ? InsertQueryBuilder<DB, TB, InsertResult> : O2 extends O & infer E ? InsertQueryBuilder<DB, TB, O & Partial<E>> : InsertQueryBuilder<DB, TB, Partial<O2>>;
@@ -744,23 +893,41 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * Turn this code:
      *
      * ```ts
+     * import type { Person } from 'type-editor' // imaginary module
+     *
      * const person = await db.insertInto('person')
-     *   .values({ ...inputPerson, nullable_column: 'hell yeah!' })
+     *   .values({
+     *     first_name: 'John',
+     *     last_name: 'Doe',
+     *     gender: 'male',
+     *     nullable_column: 'hell yeah!'
+     *   })
      *   .returningAll()
      *   .executeTakeFirstOrThrow()
      *
-     * if (nullable_column) {
+     * if (isWithNoNullValue(person)) {
      *   functionThatExpectsPersonWithNonNullValue(person)
      * }
+     *
+     * function isWithNoNullValue(person: Person): person is Person & { nullable_column: string } {
+     *   return person.nullable_column != null
+     * }
      * ```
      *
      * Into this:
      *
      * ```ts
+     * import type { NotNull } from 'kysely'
+     *
      * const person = await db.insertInto('person')
-     *   .values({ ...inputPerson, nullable_column: 'hell yeah!' })
+     *   .values({
+     *     first_name: 'John',
+     *     last_name: 'Doe',
+     *     gender: 'male',
+     *     nullable_column: 'hell yeah!'
+     *   })
      *   .returningAll()
-     *   .$narrowType<{ nullable_column: string }>()
+     *   .$narrowType<{ nullable_column: NotNull }>()
      *   .executeTakeFirstOrThrow()
      *
      * functionThatExpectsPersonWithNonNullValue(person)
@@ -790,22 +957,29 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ### Examples
      *
      * ```ts
-     * const result = await db
-     *   .with('new_person', (qb) => qb
-     *     .insertInto('person')
-     *     .values(person)
-     *     .returning('id')
-     *     .$assertType<{ id: string }>()
-     *   )
-     *   .with('new_pet', (qb) => qb
-     *     .insertInto('pet')
-     *     .values((eb) => ({ owner_id: eb.selectFrom('new_person').select('id'), ...pet }))
-     *     .returning(['name as pet_name', 'species'])
-     *     .$assertType<{ pet_name: string, species: Species }>()
-     *   )
-     *   .selectFrom(['new_person', 'new_pet'])
-     *   .selectAll()
-     *   .executeTakeFirstOrThrow()
+     * import type { NewPerson, NewPet, Species } from 'type-editor' // imaginary module
+     *
+     * async function insertPersonAndPet(person: NewPerson, pet: Omit<NewPet, 'owner_id'>) {
+     *   return await db
+     *     .with('new_person', (qb) => qb
+     *       .insertInto('person')
+     *       .values(person)
+     *       .returning('id')
+     *       .$assertType<{ id: number }>()
+     *     )
+     *     .with('new_pet', (qb) => qb
+     *       .insertInto('pet')
+     *       .values((eb) => ({
+     *         owner_id: eb.selectFrom('new_person').select('id'),
+     *         ...pet
+     *       }))
+     *       .returning(['name as pet_name', 'species'])
+     *       .$assertType<{ pet_name: string, species: Species }>()
+     *     )
+     *     .selectFrom(['new_person', 'new_pet'])
+     *     .selectAll()
+     *     .executeTakeFirstOrThrow()
+     * }
      * ```
      */
     $assertType<T extends O>(): O extends T ? InsertQueryBuilder<DB, TB, T> : KyselyTypeError<`$assertType() call failed: The type passed in is not equal to the output type of the query.`>;
@@ -844,7 +1018,7 @@ export declare class InsertQueryBuilder<DB, TB extends keyof DB, O> implements R
      * ### Examples
      *
      * ```ts
-     * const stream = db.
+     * const stream = db
      *   .selectFrom('person')
      *   .select(['first_name', 'last_name'])
      *   .where('gender', '=', 'other')