kysely 0.26.0 → 0.26.1

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

@@ -81,22 +81,24 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
      *
      * <!-- siteExample("where", "OR where", 30) -->
      *
-     * To combine conditions using `OR`, you can use the expression builder:
+     * To combine conditions using `OR`, you can use the expression builder.
+     * There are two ways to create `OR` expressions. Both are shown in this
+     * example:
      *
      * ```ts
      * const persons = await db
      *   .selectFrom('person')
      *   .selectAll()
-     *   .where(({ or, and, cmpr }) => or([
-     *     and([
-     *       cmpr('first_name', '=', 'Jennifer'),
-     *       cmpr('last_name', '=', 'Aniston')
-     *     ]),
-     *     and([
-     *       cmpr('first_name', '=', 'Sylvester'),
-     *       cmpr('last_name', '=', 'Stallone')
-     *     ])
+     *   // 1. Using the `or` method on the expression builder:
+     *   .where((eb) => eb.or([
+     *     eb('first_name', '=', 'Jennifer'),
+     *     eb('first_name', '=', 'Sylvester')
      *   ]))
+     *   // 2. Chaining expressions using the `or` method on the
+     *   // created expressions:
+     *   .where((eb) =>
+     *     eb('last_name', '=', 'Aniston').or('last_name', '=', 'Stallone')
+     *   )
      *   .execute()
      * ```
      *
@@ -106,9 +108,9 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
      * select *
      * from "person"
      * where (
-     *   ("first_name" = $1 AND "last_name" = $2)
-     *   OR
-     *   ("first_name" = $3 AND "last_name" = $4)
+     *   ("first_name" = $1 or "first_name" = $2)
+     *   and
+     *   ("last_name" = $3 or "last_name" = $4)
      * )
      * ```
      *
@@ -117,8 +119,12 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
      * You can add expressions conditionally like this:
      *
      * ```ts
+     * import { Expression, SqlBool } from 'kysely'
+     *
      * const firstName: string | undefined = 'Jennifer'
      * const lastName: string | undefined = 'Aniston'
+     * const under18 = true
+     * const over60 = true
      *
      * let query = db
      *   .selectFrom('person')
@@ -134,6 +140,23 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
      *   query = query.where('last_name', '=', lastName)
      * }
      *
+     * if (under18 || over60) {
+     *   // Conditional OR expressions can be added like this.
+     *   query = query.where((eb) => {
+     *     const ors: Expression<SqlBool>[] = []
+     *
+     *     if (under18) {
+     *       ors.push(eb('age', '<', 18))
+     *     }
+     *
+     *     if (over60) {
+     *       ors.push(eb('age', '>', 60))
+     *     }
+     *
+     *     return eb.or(ors)
+     *   })
+     * }
+     *
      * const persons = await query.execute()
      * ```
      *
@@ -198,10 +221,10 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
      * const persons = await db
      *   .selectFrom('person')
      *   .selectAll('person')
-     *   .where(({ cmpr, or, and, not, exists, selectFrom }) => and([
+     *   .where(({ eb, or, and, not, exists, selectFrom }) => and([
      *     or([
-     *       cmpr('first_name', '=', firstName),
-     *       cmpr('age', '<', maxAge)
+     *       eb('first_name', '=', firstName),
+     *       eb('age', '<', maxAge)
      *     ]),
      *     not(exists(
      *       selectFrom('pet')
@@ -544,7 +567,38 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
      * update "person" set "first_name" = $1, "last_name" = $2 where "id" = $3
      * ```
      *
-     * On PostgreSQL you ca chain `returning` to the query to get
+     * <!-- siteExample("update", "Complex values", 20) -->
+     *
+     * As always, you can provide a callback to the `set` method to get access
+     * to an expression builder:
+     *
+     * ```ts
+     * const result = await db
+     *   .updateTable('person')
+     *   .set((eb) => ({
+     *     age: eb('age', '+', 1),
+     *     first_name: eb.selectFrom('pet').select('name').limit(1),
+     *     last_name: 'updated',
+     *   }))
+     *   .where('id', '=', '1')
+     *   .executeTakeFirst()
+     *
+     * console.log(result.numUpdatedRows)
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * update "person"
+     * set
+     *   "first_name" = (select "name" from "pet" limit $1),
+     *   "age" = "age" + $2,
+     *   "last_name" = $3
+     * where
+     *   "id" = $4
+     * ```
+     *
+     * On PostgreSQL you can chain `returning` to the query to get
      * the updated rows' columns (or any other expression) as the
      * return value:
      *
@@ -726,7 +780,7 @@ export declare class UpdateQueryBuilder<DB, UT extends keyof DB, TB extends keyo
      * }
      * ```
      */
-    $if<O2>(condition: boolean, func: (qb: this) => UpdateQueryBuilder<DB, UT, TB, O2>): O2 extends UpdateResult ? UpdateQueryBuilder<DB, UT, TB, UpdateResult> : O2 extends O & infer E ? UpdateQueryBuilder<DB, UT, TB, O & Partial<E>> : UpdateQueryBuilder<DB, UT, TB, Partial<O2>>;
+    $if<O2>(condition: boolean, func: (qb: this) => UpdateQueryBuilder<any, any, any, O2>): O2 extends UpdateResult ? UpdateQueryBuilder<DB, UT, TB, UpdateResult> : O2 extends O & infer E ? UpdateQueryBuilder<DB, UT, TB, O & Partial<E>> : UpdateQueryBuilder<DB, UT, TB, Partial<O2>>;
     /**
      * Change the output type of the query.
      *

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

@@ -59,22 +59,24 @@ export interface WhereInterface<DB, TB extends keyof DB> {
      *
      * <!-- siteExample("where", "OR where", 30) -->
      *
-     * To combine conditions using `OR`, you can use the expression builder:
+     * To combine conditions using `OR`, you can use the expression builder.
+     * There are two ways to create `OR` expressions. Both are shown in this
+     * example:
      *
      * ```ts
      * const persons = await db
      *   .selectFrom('person')
      *   .selectAll()
-     *   .where(({ or, and, cmpr }) => or([
-     *     and([
-     *       cmpr('first_name', '=', 'Jennifer'),
-     *       cmpr('last_name', '=', 'Aniston')
-     *     ]),
-     *     and([
-     *       cmpr('first_name', '=', 'Sylvester'),
-     *       cmpr('last_name', '=', 'Stallone')
-     *     ])
+     *   // 1. Using the `or` method on the expression builder:
+     *   .where((eb) => eb.or([
+     *     eb('first_name', '=', 'Jennifer'),
+     *     eb('first_name', '=', 'Sylvester')
      *   ]))
+     *   // 2. Chaining expressions using the `or` method on the
+     *   // created expressions:
+     *   .where((eb) =>
+     *     eb('last_name', '=', 'Aniston').or('last_name', '=', 'Stallone')
+     *   )
      *   .execute()
      * ```
      *
@@ -84,9 +86,9 @@ export interface WhereInterface<DB, TB extends keyof DB> {
      * select *
      * from "person"
      * where (
-     *   ("first_name" = $1 AND "last_name" = $2)
-     *   OR
-     *   ("first_name" = $3 AND "last_name" = $4)
+     *   ("first_name" = $1 or "first_name" = $2)
+     *   and
+     *   ("last_name" = $3 or "last_name" = $4)
      * )
      * ```
      *
@@ -95,8 +97,12 @@ export interface WhereInterface<DB, TB extends keyof DB> {
      * You can add expressions conditionally like this:
      *
      * ```ts
+     * import { Expression, SqlBool } from 'kysely'
+     *
      * const firstName: string | undefined = 'Jennifer'
      * const lastName: string | undefined = 'Aniston'
+     * const under18 = true
+     * const over60 = true
      *
      * let query = db
      *   .selectFrom('person')
@@ -112,6 +118,23 @@ export interface WhereInterface<DB, TB extends keyof DB> {
      *   query = query.where('last_name', '=', lastName)
      * }
      *
+     * if (under18 || over60) {
+     *   // Conditional OR expressions can be added like this.
+     *   query = query.where((eb) => {
+     *     const ors: Expression<SqlBool>[] = []
+     *
+     *     if (under18) {
+     *       ors.push(eb('age', '<', 18))
+     *     }
+     *
+     *     if (over60) {
+     *       ors.push(eb('age', '>', 60))
+     *     }
+     *
+     *     return eb.or(ors)
+     *   })
+     * }
+     *
      * const persons = await query.execute()
      * ```
      *
@@ -176,10 +199,10 @@ export interface WhereInterface<DB, TB extends keyof DB> {
      * const persons = await db
      *   .selectFrom('person')
      *   .selectAll('person')
-     *   .where(({ cmpr, or, and, not, exists, selectFrom }) => and([
+     *   .where(({ eb, or, and, not, exists, selectFrom }) => and([
      *     or([
-     *       cmpr('first_name', '=', firstName),
-     *       cmpr('age', '<', maxAge)
+     *       eb('first_name', '=', firstName),
+     *       eb('age', '<', maxAge)
      *     ]),
      *     not(exists(
      *       selectFrom('pet')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.26.0",
+  "version": "0.26.1",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",