import { AliasedExpression } from '../expression/expression.js'; import { MergeQueryNode } from '../operation-node/merge-query-node.js'; import { OperationNodeSource } from '../operation-node/operation-node-source.js'; import { QueryNode } from '../operation-node/query-node.js'; import { ComparisonOperatorExpression, OperandValueExpressionOrList } from '../parser/binary-operation-parser.js'; import { ExpressionOrFactory } from '../parser/expression-parser.js'; import { InsertObjectOrList, InsertObjectOrListFactory } from '../parser/insert-values-parser.js'; import { JoinCallbackExpression, JoinReferenceExpression } from '../parser/join-parser.js'; import { ReferenceExpression } from '../parser/reference-parser.js'; import { TableExpression } from '../parser/table-parser.js'; import { ExtractUpdateTypeFromReferenceExpression, UpdateObject, UpdateObjectFactory } from '../parser/update-set-parser.js'; import { ValueExpression } from '../parser/value-parser.js'; import { CompiledQuery } from '../query-compiler/compiled-query.js'; import { QueryExecutor } from '../query-executor/query-executor.js'; import { Compilable } from '../util/compilable.js'; import { QueryId } from '../util/query-id.js'; import { ShallowRecord, SimplifyResult, SimplifySingleResult, SqlBool } from '../util/type-utils.js'; import { MergeResult } from './merge-result.js'; import { NoResultErrorConstructor } from './no-result-error.js'; import { UpdateQueryBuilder } from './update-query-builder.js'; export declare class MergeQueryBuilder { #private; constructor(props: MergeQueryBuilderProps); /** * Changes a `merge into` query to an `merge top into` query. * * `top` clause is only supported by some dialects like MS SQL Server. * * ### Examples * * Affect 5 matched rows at most: * * ```ts * await db.mergeInto('person') * .top(5) * .using('pet', 'person.id', 'pet.owner_id') * .whenMatched() * .thenDelete() * .execute() * ``` * * The generated SQL (MS SQL Server): * * ```sql * merge top(5) into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when matched then * delete * ``` * * Affect 50% of matched rows: * * ```ts * await db.mergeInto('person') * .top(50, 'percent') * .using('pet', 'person.id', 'pet.owner_id') * .whenMatched() * .thenDelete() * .execute() * ``` * * The generated SQL (MS SQL Server): * * ```sql * merge top(50) percent into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when matched then * delete * ``` */ top(expression: number | bigint, modifiers?: 'percent'): MergeQueryBuilder; /** * Adds the `using` clause to the query. * * This method is similar to {@link SelectQueryBuilder.innerJoin}, so see the * documentation for that method for more examples. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenMatched() * .thenDelete() * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when matched then * delete * ``` */ using, K1 extends JoinReferenceExpression, K2 extends JoinReferenceExpression>(sourceTable: TE, k1: K1, k2: K2): ExtractWheneableMergeQueryBuilder; using, FN extends JoinCallbackExpression>(sourceTable: TE, callback: FN): ExtractWheneableMergeQueryBuilder; } export interface MergeQueryBuilderProps { readonly queryId: QueryId; readonly queryNode: MergeQueryNode; readonly executor: QueryExecutor; } export declare class WheneableMergeQueryBuilder implements Compilable, OperationNodeSource { #private; constructor(props: MergeQueryBuilderProps); /** * See {@link MergeQueryBuilder.top}. */ top(expression: number | bigint, modifiers?: 'percent'): WheneableMergeQueryBuilder; /** * Adds a simple `when matched` clause to the query. * * For a `when matched` clause with an `and` condition, see {@link whenMatchedAnd}. * * For a simple `when not matched` clause, see {@link whenNotMatched}. * * For a `when not matched` clause with an `and` condition, see {@link whenNotMatchedAnd}. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenMatched() * .thenDelete() * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when matched then * delete * ``` */ whenMatched(): MatchedThenableMergeQueryBuilder; /** * Adds the `when matched` clause to the query with an `and` condition. * * This method is similar to {@link SelectQueryBuilder.where}, so see the documentation * for that method for more examples. * * For a simple `when matched` clause (without an `and` condition) see {@link whenMatched}. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenMatchedAnd('person.first_name', '=', 'John') * .thenDelete() * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when matched and "person"."first_name" = $1 then * delete * ``` */ whenMatchedAnd, VE extends OperandValueExpressionOrList>(lhs: RE, op: ComparisonOperatorExpression, rhs: VE): MatchedThenableMergeQueryBuilder; whenMatchedAnd>(expression: E): MatchedThenableMergeQueryBuilder; /** * Adds the `when matched` clause to the query with an `and` condition. But unlike * {@link whenMatchedAnd}, this method accepts a column reference as the 3rd argument. * * This method is similar to {@link SelectQueryBuilder.whereRef}, so see the documentation * for that method for more examples. */ whenMatchedAndRef, RRE extends ReferenceExpression>(lhs: LRE, op: ComparisonOperatorExpression, rhs: RRE): MatchedThenableMergeQueryBuilder; /** * Adds a simple `when not matched` clause to the query. * * For a `when not matched` clause with an `and` condition, see {@link whenNotMatchedAnd}. * * For a simple `when matched` clause, see {@link whenMatched}. * * For a `when matched` clause with an `and` condition, see {@link whenMatchedAnd}. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenNotMatched() * .thenInsertValues({ * first_name: 'John', * last_name: 'Doe', * }) * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when not matched then * insert ("first_name", "last_name") values ($1, $2) * ``` */ whenNotMatched(): NotMatchedThenableMergeQueryBuilder; /** * Adds the `when not matched` clause to the query with an `and` condition. * * This method is similar to {@link SelectQueryBuilder.where}, so see the documentation * for that method for more examples. * * For a simple `when not matched` clause (without an `and` condition) see {@link whenNotMatched}. * * Unlike {@link whenMatchedAnd}, you cannot reference columns from the table merged into. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenNotMatchedAnd('pet.name', '=', 'Lucky') * .thenInsertValues({ * first_name: 'John', * last_name: 'Doe', * }) * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when not matched and "pet"."name" = $1 then * insert ("first_name", "last_name") values ($2, $3) * ``` */ whenNotMatchedAnd, VE extends OperandValueExpressionOrList>(lhs: RE, op: ComparisonOperatorExpression, rhs: VE): NotMatchedThenableMergeQueryBuilder; whenNotMatchedAnd>(expression: E): NotMatchedThenableMergeQueryBuilder; /** * Adds the `when not matched` clause to the query with an `and` condition. But unlike * {@link whenNotMatchedAnd}, this method accepts a column reference as the 3rd argument. * * Unlike {@link whenMatchedAndRef}, you cannot reference columns from the target table. * * This method is similar to {@link SelectQueryBuilder.whereRef}, so see the documentation * for that method for more examples. */ whenNotMatchedAndRef, RRE extends ReferenceExpression>(lhs: LRE, op: ComparisonOperatorExpression, rhs: RRE): NotMatchedThenableMergeQueryBuilder; /** * Adds a simple `when not matched by source` clause to the query. * * Supported in MS SQL Server. * * Similar to {@link whenNotMatched}, but returns a {@link MatchedThenableMergeQueryBuilder}. */ whenNotMatchedBySource(): MatchedThenableMergeQueryBuilder; /** * Adds the `when not matched by source` clause to the query with an `and` condition. * * Supported in MS SQL Server. * * Similar to {@link whenNotMatchedAnd}, but returns a {@link MatchedThenableMergeQueryBuilder}. */ whenNotMatchedBySourceAnd, VE extends OperandValueExpressionOrList>(lhs: RE, op: ComparisonOperatorExpression, rhs: VE): MatchedThenableMergeQueryBuilder; whenNotMatchedBySourceAnd>(expression: E): MatchedThenableMergeQueryBuilder; /** * Adds the `when not matched by source` clause to the query with an `and` condition. * * Similar to {@link whenNotMatchedAndRef}, but you can reference columns from * the target table, and not from source table and returns a {@link MatchedThenableMergeQueryBuilder}. */ whenNotMatchedBySourceAndRef, RRE extends ReferenceExpression>(lhs: LRE, op: ComparisonOperatorExpression, rhs: RRE): MatchedThenableMergeQueryBuilder; /** * Simply calls the provided function passing `this` as the only argument. `$call` returns * what the provided function returns. * * If you want to conditionally call a method on `this`, see * the {@link $if} method. * * ### Examples * * The next example uses a helper function `log` to log a query: * * ```ts * function log(qb: T): T { * console.log(qb.compile()) * return qb * } * * db.updateTable('person') * .set(values) * .$call(log) * .execute() * ``` */ $call(func: (qb: this) => T): T; /** * Call `func(this)` if `condition` is true. * * This method is especially handy with optional selects. Any `returning` or `returningAll` * method calls add columns as optional fields to the output type when called inside * the `func` callback. This is because we can't know if those selections were actually * made before running the code. * * You can also call any other methods inside the callback. * * ### Examples * * ```ts * async function updatePerson(id: number, updates: UpdateablePerson, returnLastName: boolean) { * return await db * .updateTable('person') * .set(updates) * .where('id', '=', id) * .returning(['id', 'first_name']) * .$if(returnLastName, (qb) => qb.returning('last_name')) * .executeTakeFirstOrThrow() * } * ``` * * Any selections added inside the `if` callback will be added as optional fields to the * output type since we can't know if the selections were actually made before running * the code. In the example above the return type of the `updatePerson` function is: * * ```ts * { * id: number * first_name: string * last_name?: string * } * ``` */ $if(condition: boolean, func: (qb: this) => WheneableMergeQueryBuilder): O2 extends MergeResult ? WheneableMergeQueryBuilder : O2 extends O & infer E ? WheneableMergeQueryBuilder> : WheneableMergeQueryBuilder>; toOperationNode(): MergeQueryNode; compile(): CompiledQuery; /** * Executes the query and returns an array of rows. * * Also see the {@link executeTakeFirst} and {@link executeTakeFirstOrThrow} methods. */ execute(): Promise[]>; /** * Executes the query and returns the first result or undefined if * the query returned no result. */ executeTakeFirst(): Promise>; /** * Executes the query and returns the first result or throws if * the query returned no result. * * By default an instance of {@link NoResultError} is thrown, but you can * provide a custom error class, or callback as the only argument to throw a different * error. */ executeTakeFirstOrThrow(errorConstructor?: NoResultErrorConstructor | ((node: QueryNode) => Error)): Promise>; } export declare class MatchedThenableMergeQueryBuilder { #private; constructor(props: MergeQueryBuilderProps); /** * Performs the `delete` action. * * To perform the `do nothing` action, see {@link thenDoNothing}. * * To perform the `update` action, see {@link thenUpdate} or {@link thenUpdateSet}. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenMatched() * .thenDelete() * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when matched then * delete * ``` */ thenDelete(): WheneableMergeQueryBuilder; /** * Performs the `do nothing` action. * * This is supported in PostgreSQL. * * To perform the `delete` action, see {@link thenDelete}. * * To perform the `update` action, see {@link thenUpdate} or {@link thenUpdateSet}. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenMatched() * .thenDoNothing() * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when matched then * do nothing * ``` */ thenDoNothing(): WheneableMergeQueryBuilder; /** * Perform an `update` operation with a full-fledged {@link UpdateQueryBuilder}. * This is handy when multiple `set` invocations are needed. * * For a shorthand version of this method, see {@link thenUpdateSet}. * * To perform the `delete` action, see {@link thenDelete}. * * To perform the `do nothing` action, see {@link thenDoNothing}. * * ### Examples * * ```ts * import { sql } from 'kysely' * * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenMatched() * .thenUpdate((ub) => ub * .set(sql`metadata['has_pets']`, 'Y') * .set({ * updated_at: Date.now(), * }) * ) * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when matched then * update set metadata['has_pets'] = $1, "updated_at" = $2 * ``` */ thenUpdate>(set: (ub: QB) => QB): WheneableMergeQueryBuilder; /** * Performs an `update set` action, similar to {@link UpdateQueryBuilder.set}. * * For a full-fledged update query builder, see {@link thenUpdate}. * * To perform the `delete` action, see {@link thenDelete}. * * To perform the `do nothing` action, see {@link thenDoNothing}. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenMatched() * .thenUpdateSet({ * middle_name: 'dog owner', * }) * .execute() * ``` * * The generate SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when matched then * update set "middle_name" = $1 * ``` */ thenUpdateSet>(update: UO): WheneableMergeQueryBuilder; thenUpdateSet>(update: U): WheneableMergeQueryBuilder; thenUpdateSet, VE extends ValueExpression>>(key: RE, value: VE): WheneableMergeQueryBuilder; } export declare class NotMatchedThenableMergeQueryBuilder { #private; constructor(props: MergeQueryBuilderProps); /** * Performs the `do nothing` action. * * This is supported in PostgreSQL. * * To perform the `insert` action, see {@link thenInsertValues}. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenNotMatched() * .thenDoNothing() * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when not matched then * do nothing * ``` */ thenDoNothing(): WheneableMergeQueryBuilder; /** * Performs the `insert (...) values` action. * * This method is similar to {@link InsertQueryBuilder.values}, so see the documentation * for that method for more examples. * * To perform the `do nothing` action, see {@link thenDoNothing}. * * ### Examples * * ```ts * const result = await db.mergeInto('person') * .using('pet', 'person.id', 'pet.owner_id') * .whenNotMatched() * .thenInsertValues({ * first_name: 'John', * last_name: 'Doe', * }) * .execute() * ``` * * The generated SQL (PostgreSQL): * * ```sql * merge into "person" * using "pet" on "person"."id" = "pet"."owner_id" * when not matched then * insert ("first_name", "last_name") values ($1, $2) * ``` */ thenInsertValues>(insert: I): WheneableMergeQueryBuilder; thenInsertValues>(insert: IO): WheneableMergeQueryBuilder; } export type ExtractWheneableMergeQueryBuilder, O> = TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? UsingBuilder : never : TE extends keyof DB ? WheneableMergeQueryBuilder : TE extends AliasedExpression ? UsingBuilder : TE extends (qb: any) => AliasedExpression ? UsingBuilder : never; type UsingBuilder = A extends keyof DB ? WheneableMergeQueryBuilder : WheneableMergeQueryBuilder, TT, A, O>; export {};