kysely 0.27.3 → 0.27.5

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

@@ -138,11 +138,10 @@ export class InsertQueryBuilder {
      *   .insertInto('person')
      *   .values(({ ref, selectFrom, fn }) => ({
      *     first_name: 'Jennifer',
-     *     last_name: sql`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')),
+     *       .select(fn.avg<number>('age').as('avg_age')),
      *   }))
      *   .executeTakeFirst()
      * ```
@@ -167,7 +166,7 @@ export class InsertQueryBuilder {
      * 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'])
@@ -177,6 +176,24 @@ export class InsertQueryBuilder {
      *   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) {
@@ -199,9 +216,10 @@ export class InsertQueryBuilder {
      * ### 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):
@@ -226,7 +244,9 @@ export class InsertQueryBuilder {
      *
      * <!-- siteExample("insert", "Insert subquery", 50) -->
      *
-     * You can create an `INSERT INTO SELECT FROM` query using the `expression` method:
+     * You can create an `INSERT INTO SELECT FROM` query using the `expression` method.
+     * This API doesn't follow our WYSIWYG principles and might be a bit difficult to
+     * remember. The reasons for this design stem from implementation difficulties.
      *
      * ```ts
      * const result = await db.insertInto('person')
@@ -267,6 +287,12 @@ export class InsertQueryBuilder {
      *   .defaultValues()
      *   .execute()
      * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * insert into "person" default values
+     * ```
      */
     defaultValues() {
         return new InsertQueryBuilder({
@@ -276,6 +302,37 @@ export class InsertQueryBuilder {
             }),
         });
     }
+    /**
+     * 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) {
+        return new InsertQueryBuilder({
+            ...this.#props,
+            queryNode: QueryNode.cloneWithEndModifier(this.#props.queryNode, modifier.toOperationNode()),
+        });
+    }
     /**
      * Changes an `insert into` query to an `insert ignore into` query.
      *
@@ -293,9 +350,19 @@ export class InsertQueryBuilder {
      * ```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() {
         return new InsertQueryBuilder({
@@ -315,6 +382,8 @@ export class InsertQueryBuilder {
      * Insert the first 5 rows:
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * await db.insertInto('person')
      *   .top(5)
      *   .columns(['first_name', 'gender'])
@@ -333,6 +402,8 @@ export class InsertQueryBuilder {
      * Insert the first 50 percent of rows:
      *
      * ```ts
+     * import { sql } from 'kysely'
+     *
      * await db.insertInto('person')
      *   .top(50, 'percent')
      *   .columns(['first_name', 'gender'])
@@ -368,6 +439,7 @@ export class InsertQueryBuilder {
      *   .values({
      *     name: 'Catto',
      *     species: 'cat',
+     *     owner_id: 3,
      *   })
      *   .onConflict((oc) => oc
      *     .column('name')
@@ -379,10 +451,10 @@ export class InsertQueryBuilder {
      * 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:
@@ -393,6 +465,7 @@ export class InsertQueryBuilder {
      *   .values({
      *     name: 'Catto',
      *     species: 'cat',
+     *     owner_id: 3,
      *   })
      *   .onConflict((oc) => oc
      *     .constraint('pet_name_key')
@@ -404,10 +477,10 @@ export class InsertQueryBuilder {
      * 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
@@ -421,9 +494,10 @@ export class InsertQueryBuilder {
      *   .values({
      *     name: 'Catto',
      *     species: 'cat',
+     *     owner_id: 3,
      *   })
      *   .onConflict((oc) => oc
-     *     .expression(sql`lower(name)`)
+     *     .expression(sql<string>`lower(name)`)
      *     .doUpdateSet({ species: 'hamster' })
      *   )
      *   .execute()
@@ -432,10 +506,10 @@ export class InsertQueryBuilder {
      * 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:
@@ -446,11 +520,12 @@ export class InsertQueryBuilder {
      *   .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()
      * ```
@@ -458,11 +533,11 @@ export class InsertQueryBuilder {
      * 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:
@@ -473,6 +548,7 @@ export class InsertQueryBuilder {
      *   .values({
      *     name: 'Catto',
      *     species: 'cat',
+     *     owner_id: 3,
      *   })
      *   .onConflict((oc) => oc
      *     .column('name')
@@ -484,8 +560,8 @@ export class InsertQueryBuilder {
      * 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
      * ```
      *
@@ -494,8 +570,13 @@ export class InsertQueryBuilder {
      * `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({
@@ -503,6 +584,18 @@ export class InsertQueryBuilder {
      *       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) {
@@ -529,8 +622,22 @@ export class InsertQueryBuilder {
      * ```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) {
@@ -553,22 +660,35 @@ export class InsertQueryBuilder {
             queryNode: QueryNode.cloneWithReturning(this.#props.queryNode, parseSelectAll()),
         });
     }
+    output(args) {
+        return new InsertQueryBuilder({
+            ...this.#props,
+            queryNode: QueryNode.cloneWithOutput(this.#props.queryNode, parseSelectArg(args)),
+        });
+    }
+    outputAll(table) {
+        return new InsertQueryBuilder({
+            ...this.#props,
+            queryNode: QueryNode.cloneWithOutput(this.#props.queryNode, parseSelectAll(table)),
+        });
+    }
     /**
      * Clears all `returning` clauses from the query.
      *
      * ### 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() {
@@ -589,13 +709,15 @@ export class InsertQueryBuilder {
      * 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()
      * ```
@@ -616,7 +738,9 @@ export class InsertQueryBuilder {
      * ### 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)
@@ -631,11 +755,11 @@ export class InsertQueryBuilder {
      * 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(condition, func) {
@@ -673,23 +797,41 @@ export class InsertQueryBuilder {
      * 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)
@@ -701,17 +843,17 @@ export class InsertQueryBuilder {
     /**
      * 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
+     * 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:
+     * 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
+     * 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.
      *
@@ -721,22 +863,29 @@ export class InsertQueryBuilder {
      * ### 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() {
@@ -764,9 +913,11 @@ export class InsertQueryBuilder {
      */
     async execute() {
         const compiledQuery = this.compile();
-        const query = compiledQuery.query;
         const result = await this.#props.executor.executeQuery(compiledQuery, this.#props.queryId);
-        if (this.#props.executor.adapter.supportsReturning && query.returning) {
+        const { adapter } = this.#props.executor;
+        const query = compiledQuery.query;
+        if ((query.returning && adapter.supportsReturning) ||
+            (query.output && adapter.supportsOutput)) {
             return result.rows;
         }
         return [

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

@@ -13,12 +13,17 @@
  * ### Examples
  *
  * ```ts
- * const result = await db
- *   .insertInto('person')
- *   .values(person)
- *   .executeTakeFirst()
+ * import type { NewPerson } from 'type-editor' // imaginary module
  *
- * console.log(result.insertId)
+ * async function insertPerson(person: NewPerson) {
+ *   const result = await db
+ *     .insertInto('person')
+ *     .values(person)
+ *     .executeTakeFirstOrThrow()
+ *
+ *   console.log(result.insertId) // relevant on MySQL
+ *   console.log(result.numInsertedOrUpdatedRows) // always relevant
+ * }
  * ```
  */
 export declare class InsertResult {

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

@@ -14,12 +14,17 @@
  * ### Examples
  *
  * ```ts
- * const result = await db
- *   .insertInto('person')
- *   .values(person)
- *   .executeTakeFirst()
+ * import type { NewPerson } from 'type-editor' // imaginary module
  *
- * console.log(result.insertId)
+ * async function insertPerson(person: NewPerson) {
+ *   const result = await db
+ *     .insertInto('person')
+ *     .values(person)
+ *     .executeTakeFirstOrThrow()
+ *
+ *   console.log(result.insertId) // relevant on MySQL
+ *   console.log(result.numInsertedOrUpdatedRows) // always relevant
+ * }
  * ```
  */
 export class InsertResult {