kysely 0.25.0 → 0.26.0

package/dist/esm/query-builder/on-conflict-builder.d.ts

@@ -2,7 +2,6 @@ import { Expression } from '../expression/expression.js';
 import { OnConflictNode } from '../operation-node/on-conflict-node.js';
 import { OperationNodeSource } from '../operation-node/operation-node-source.js';
 import { ComparisonOperatorExpression, OperandValueExpressionOrList } from '../parser/binary-operation-parser.js';
-import { ExpressionOrFactory } from '../parser/expression-parser.js';
 import { ReferenceExpression } from '../parser/reference-parser.js';
 import { UpdateExpression } from '../parser/update-set-parser.js';
 import { AnyColumn } from '../util/type-utils.js';
@@ -55,6 +54,10 @@ export declare class OnConflictBuilder<DB, TB extends keyof DB> implements Where
      *
      * ### Examples
      *
+     * <!-- siteExample("where", "Simple where clause", 10) -->
+     *
+     * `where` method calls are combined with `AND`:
+     *
      * ```ts
      * const person = await db
      *   .selectFrom('person')
@@ -77,9 +80,65 @@ export declare class OnConflictBuilder<DB, TB extends keyof DB> implements Where
      * sql`your operator`
      * ```
      *
+     * <!-- siteExample("where", "Where in", 20) -->
+     *
+     * Find multiple items using a list of identifiers:
+     *
+     * ```ts
+     * const persons = await db
+     *   .selectFrom('person')
+     *   .selectAll()
+     *   .where('id', 'in', ['1', '2', '3'])
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select * from "person" where "id" in ($1, $2, $3)
+     * ```
+     *
+     * <!-- siteExample("where", "OR where", 30) -->
+     *
+     * To combine conditions using `OR`, you can use the expression builder:
+     *
+     * ```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')
+     *     ])
+     *   ]))
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select *
+     * from "person"
+     * where (
+     *   ("first_name" = $1 AND "last_name" = $2)
+     *   OR
+     *   ("first_name" = $3 AND "last_name" = $4)
+     * )
+     * ```
+     *
+     * <!-- siteExample("where", "Conditional where calls", 40) -->
+     *
      * You can add expressions conditionally like this:
      *
      * ```ts
+     * const firstName: string | undefined = 'Jennifer'
+     * const lastName: string | undefined = 'Aniston'
+     *
      * let query = db
      *   .selectFrom('person')
      *   .selectAll()
@@ -146,22 +205,30 @@ export declare class OnConflictBuilder<DB, TB extends keyof DB> implements Where
      * select * from "person" where "id" in ($1, $2, $3)
      * ```
      *
+     * <!-- siteExample("where", "Complex where clause", 50) -->
+     *
      * For complex `where` expressions you can pass in a single callback and
-     * use the {@link ExpressionBuilder} to build your expression:
+     * use the `ExpressionBuilder` to build your expression:
      *
      * ```ts
+     * const firstName = 'Jennifer'
+     * const maxAge = 60
+     *
      * const persons = await db
      *   .selectFrom('person')
      *   .selectAll('person')
-     *   .where(({ cmpr, or, and, not, exists, selectFrom, val }) => and([
+     *   .where(({ cmpr, or, and, not, exists, selectFrom }) => and([
      *     or([
      *       cmpr('first_name', '=', firstName),
      *       cmpr('age', '<', maxAge)
      *     ]),
      *     not(exists(
-     *       selectFrom('pet').select('pet.id').whereRef('pet.owner_id', '=', 'person.id')
+     *       selectFrom('pet')
+     *         .select('pet.id')
+     *         .whereRef('pet.owner_id', '=', 'person.id')
      *     ))
      *   ]))
+     *   .execute()
      * ```
      *
      * The generated SQL (PostgreSQL):
@@ -235,38 +302,6 @@ export declare class OnConflictBuilder<DB, TB extends keyof DB> implements Where
      * See {@link WhereInterface.whereRef} for more info.
      */
     whereRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): OnConflictBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhere<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): OnConflictBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhere(factory: WhereExpressionFactory<DB, TB>): OnConflictBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhere(expression: Expression<any>): OnConflictBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): OnConflictBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereNotExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereNotExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictBuilder<DB, TB>;
     /**
      * Clears all where expressions from the query.
      *
@@ -360,10 +395,10 @@ export declare class OnConflictBuilder<DB, TB extends keyof DB> implements Where
 export interface OnConflictBuilderProps {
     readonly onConflictNode: OnConflictNode;
 }
-export declare type OnConflictDatabase<DB, TB extends keyof DB> = {
+export type OnConflictDatabase<DB, TB extends keyof DB> = {
     [K in keyof DB | 'excluded']: K extends keyof DB ? DB[K] : DB[TB];
 };
-export declare type OnConflictTables<TB> = TB | 'excluded';
+export type OnConflictTables<TB> = TB | 'excluded';
 export declare class OnConflictDoNothingBuilder<DB, TB extends keyof DB> implements OperationNodeSource {
     #private;
     constructor(props: OnConflictBuilderProps);
@@ -387,6 +422,10 @@ export declare class OnConflictUpdateBuilder<DB, TB extends keyof DB> implements
      *
      * ### Examples
      *
+     * <!-- siteExample("where", "Simple where clause", 10) -->
+     *
+     * `where` method calls are combined with `AND`:
+     *
      * ```ts
      * const person = await db
      *   .selectFrom('person')
@@ -409,9 +448,65 @@ export declare class OnConflictUpdateBuilder<DB, TB extends keyof DB> implements
      * sql`your operator`
      * ```
      *
+     * <!-- siteExample("where", "Where in", 20) -->
+     *
+     * Find multiple items using a list of identifiers:
+     *
+     * ```ts
+     * const persons = await db
+     *   .selectFrom('person')
+     *   .selectAll()
+     *   .where('id', 'in', ['1', '2', '3'])
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select * from "person" where "id" in ($1, $2, $3)
+     * ```
+     *
+     * <!-- siteExample("where", "OR where", 30) -->
+     *
+     * To combine conditions using `OR`, you can use the expression builder:
+     *
+     * ```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')
+     *     ])
+     *   ]))
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select *
+     * from "person"
+     * where (
+     *   ("first_name" = $1 AND "last_name" = $2)
+     *   OR
+     *   ("first_name" = $3 AND "last_name" = $4)
+     * )
+     * ```
+     *
+     * <!-- siteExample("where", "Conditional where calls", 40) -->
+     *
      * You can add expressions conditionally like this:
      *
      * ```ts
+     * const firstName: string | undefined = 'Jennifer'
+     * const lastName: string | undefined = 'Aniston'
+     *
      * let query = db
      *   .selectFrom('person')
      *   .selectAll()
@@ -478,22 +573,30 @@ export declare class OnConflictUpdateBuilder<DB, TB extends keyof DB> implements
      * select * from "person" where "id" in ($1, $2, $3)
      * ```
      *
+     * <!-- siteExample("where", "Complex where clause", 50) -->
+     *
      * For complex `where` expressions you can pass in a single callback and
-     * use the {@link ExpressionBuilder} to build your expression:
+     * use the `ExpressionBuilder` to build your expression:
      *
      * ```ts
+     * const firstName = 'Jennifer'
+     * const maxAge = 60
+     *
      * const persons = await db
      *   .selectFrom('person')
      *   .selectAll('person')
-     *   .where(({ cmpr, or, and, not, exists, selectFrom, val }) => and([
+     *   .where(({ cmpr, or, and, not, exists, selectFrom }) => and([
      *     or([
      *       cmpr('first_name', '=', firstName),
      *       cmpr('age', '<', maxAge)
      *     ]),
      *     not(exists(
-     *       selectFrom('pet').select('pet.id').whereRef('pet.owner_id', '=', 'person.id')
+     *       selectFrom('pet')
+     *         .select('pet.id')
+     *         .whereRef('pet.owner_id', '=', 'person.id')
      *     ))
      *   ]))
+     *   .execute()
      * ```
      *
      * The generated SQL (PostgreSQL):
@@ -567,38 +670,6 @@ export declare class OnConflictUpdateBuilder<DB, TB extends keyof DB> implements
      * See {@link WhereInterface.whereRef} for more info.
      */
     whereRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): OnConflictUpdateBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhere<RE extends ReferenceExpression<DB, TB>>(lhs: RE, op: ComparisonOperatorExpression, rhs: OperandValueExpressionOrList<DB, TB, RE>): OnConflictUpdateBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhere(factory: WhereExpressionFactory<DB, TB>): OnConflictUpdateBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhere(expression: Expression<any>): OnConflictUpdateBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereRef(lhs: ReferenceExpression<DB, TB>, op: ComparisonOperatorExpression, rhs: ReferenceExpression<DB, TB>): OnConflictUpdateBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictUpdateBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereNotExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictUpdateBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictUpdateBuilder<DB, TB>;
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereNotExists(arg: ExpressionOrFactory<DB, TB, any>): OnConflictUpdateBuilder<DB, TB>;
     /**
      * Clears all where expressions from the query.
      *

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

@@ -2,8 +2,7 @@
 import { ColumnNode } from '../operation-node/column-node.js';
 import { IdentifierNode } from '../operation-node/identifier-node.js';
 import { OnConflictNode } from '../operation-node/on-conflict-node.js';
-import { parseReferentialComparison, parseWhere, } from '../parser/binary-operation-parser.js';
-import { parseExists, parseNotExists, } from '../parser/unary-operation-parser.js';
+import { parseFilter, parseReferentialComparison, } from '../parser/binary-operation-parser.js';
 import { parseUpdateExpression, } from '../parser/update-set-parser.js';
 import { freeze } from '../util/object-utils.js';
 import { preventAwait } from '../util/prevent-await.js';
@@ -79,7 +78,7 @@ export class OnConflictBuilder {
     where(...args) {
         return new OnConflictBuilder({
             ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, parseWhere(args)),
+            onConflictNode: OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, parseFilter(args)),
         });
     }
     /**
@@ -93,60 +92,6 @@ export class OnConflictBuilder {
             onConflictNode: OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, parseReferentialComparison(lhs, op, rhs)),
         });
     }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhere(...args) {
-        return new OnConflictBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, parseWhere(args)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereRef(lhs, op, rhs) {
-        return new OnConflictBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, parseReferentialComparison(lhs, op, rhs)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereExists(arg) {
-        return new OnConflictBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, parseExists(arg)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereNotExists(arg) {
-        return new OnConflictBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithIndexWhere(this.#props.onConflictNode, parseNotExists(arg)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereExists(arg) {
-        return new OnConflictBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, parseExists(arg)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereNotExists(arg) {
-        return new OnConflictBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithIndexOrWhere(this.#props.onConflictNode, parseNotExists(arg)),
-        });
-    }
     clearWhere() {
         return new OnConflictBuilder({
             ...this.#props,
@@ -259,7 +204,7 @@ export class OnConflictUpdateBuilder {
     where(...args) {
         return new OnConflictUpdateBuilder({
             ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, parseWhere(args)),
+            onConflictNode: OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, parseFilter(args)),
         });
     }
     /**
@@ -273,60 +218,6 @@ export class OnConflictUpdateBuilder {
             onConflictNode: OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, parseReferentialComparison(lhs, op, rhs)),
         });
     }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhere(...args) {
-        return new OnConflictUpdateBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, parseWhere(args)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereRef(lhs, op, rhs) {
-        return new OnConflictUpdateBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, parseReferentialComparison(lhs, op, rhs)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereExists(arg) {
-        return new OnConflictUpdateBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, parseExists(arg)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    whereNotExists(arg) {
-        return new OnConflictUpdateBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithUpdateWhere(this.#props.onConflictNode, parseNotExists(arg)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereExists(arg) {
-        return new OnConflictUpdateBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, parseExists(arg)),
-        });
-    }
-    /**
-     * @deprecated Follow [these](https://github.com/koskimas/kysely/releases/tag/0.24.0) instructions to migrate
-     */
-    orWhereNotExists(arg) {
-        return new OnConflictUpdateBuilder({
-            ...this.#props,
-            onConflictNode: OnConflictNode.cloneWithUpdateOrWhere(this.#props.onConflictNode, parseNotExists(arg)),
-        });
-    }
     clearWhere() {
         return new OnConflictUpdateBuilder({
             ...this.#props,

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

@@ -14,7 +14,7 @@ export declare class OverBuilder<DB, TB extends keyof DB> implements OperationNo
      * const result = await db
      *   .selectFrom('person')
      *   .select(
-     *     eb => eb.fn.avg<number>('age').over(
+     *     (eb) => eb.fn.avg<number>('age').over(
      *       ob => ob.orderBy('first_name', 'asc').orderBy('last_name', 'asc')
      *     ).as('average_age')
      *   )
@@ -36,7 +36,7 @@ export declare class OverBuilder<DB, TB extends keyof DB> implements OperationNo
      * const result = await db
      *   .selectFrom('person')
      *   .select(
-     *     eb => eb.fn.avg<number>('age').over(
+     *     (eb) => eb.fn.avg<number>('age').over(
      *       ob => ob.partitionBy(['last_name', 'first_name'])
      *     ).as('average_age')
      *   )

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

@@ -16,7 +16,7 @@ export class OverBuilder {
      * const result = await db
      *   .selectFrom('person')
      *   .select(
-     *     eb => eb.fn.avg<number>('age').over(
+     *     (eb) => eb.fn.avg<number>('age').over(
      *       ob => ob.orderBy('first_name', 'asc').orderBy('last_name', 'asc')
      *     ).as('average_age')
      *   )

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

@@ -53,7 +53,7 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
-     *   .returning(eb => [
+     *   .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')