import { entityKind } from "../../entity.js"; import type { PgDialect } from "../dialect.js"; import type { PgPreparedQuery, PgQueryResultHKT, PgQueryResultKind, PgSession, PreparedQueryConfig } from "../session.js"; import type { PgTable } from "../table.js"; import { TypedQueryBuilder } from "../../query-builders/query-builder.js"; import type { SelectResultFields } from "../../query-builders/select.types.js"; import { QueryPromise } from "../../query-promise.js"; import type { RunnableQuery } from "../../runnable-query.js"; import type { ColumnsSelection, Query, SQL, SQLWrapper } from "../../sql/sql.js"; import type { Subquery } from "../../subquery.js"; import type { SelectedFieldsFlat, SelectedFieldsOrdered } from "./select.types.js"; export type PgDeleteWithout = TDynamic extends true ? T : Omit, T['_']['excludedMethods'] | K>; export type PgDelete | undefined = Record | undefined> = PgDeleteBase; export interface PgDeleteConfig { where?: SQL | undefined; table: PgTable; returningFields?: SelectedFieldsFlat; returning?: SelectedFieldsOrdered; withList?: Subquery[]; } export type PgDeleteReturningAll = PgDeleteWithout, TDynamic, 'returning'>; export type PgDeleteReturning = PgDeleteWithout, TDynamic, T['_']['excludedMethods']>, TDynamic, 'returning'>; export type PgDeletePrepare = PgPreparedQuery : T['_']['returning'][]; }>; export type PgDeleteDynamic = PgDelete; export type AnyPgDeleteBase = PgDeleteBase; export interface PgDeleteBase | undefined = undefined, TDynamic extends boolean = false, TExcludedMethods extends string = never> extends TypedQueryBuilder : TReturning[]>, QueryPromise : TReturning[]>, RunnableQuery : TReturning[], 'pg'>, SQLWrapper { readonly _: { readonly dialect: 'pg'; readonly table: TTable; readonly queryResult: TQueryResult; readonly selectedFields: TSelectedFields; readonly returning: TReturning; readonly dynamic: TDynamic; readonly excludedMethods: TExcludedMethods; readonly result: TReturning extends undefined ? PgQueryResultKind : TReturning[]; }; } export declare class PgDeleteBase | undefined = undefined, TDynamic extends boolean = false, TExcludedMethods extends string = never> extends QueryPromise : TReturning[]> implements TypedQueryBuilder : TReturning[]>, RunnableQuery : TReturning[], 'pg'>, SQLWrapper { private session; private dialect; static readonly [entityKind]: string; private config; constructor(table: TTable, session: PgSession, dialect: PgDialect, withList?: Subquery[]); /** * Adds a `where` clause to the query. * * Calling this method will delete only those rows that fulfill a specified condition. * * See docs: {@link https://orm.drizzle.team/docs/delete} * * @param where the `where` clause. * * @example * You can use conditional operators and `sql function` to filter the rows to be deleted. * * ```ts * // Delete all cars with green color * await db.delete(cars).where(eq(cars.color, 'green')); * // or * await db.delete(cars).where(sql`${cars.color} = 'green'`) * ``` * * You can logically combine conditional operators with `and()` and `or()` operators: * * ```ts * // Delete all BMW cars with a green color * await db.delete(cars).where(and(eq(cars.color, 'green'), eq(cars.brand, 'BMW'))); * * // Delete all cars with the green or blue color * await db.delete(cars).where(or(eq(cars.color, 'green'), eq(cars.color, 'blue'))); * ``` */ where(where: SQL | undefined): PgDeleteWithout; /** * Adds a `returning` clause to the query. * * Calling this method will return the specified fields of the deleted rows. If no fields are specified, all fields will be returned. * * See docs: {@link https://orm.drizzle.team/docs/delete#delete-with-return} * * @example * ```ts * // Delete all cars with the green color and return all fields * const deletedCars: Car[] = await db.delete(cars) * .where(eq(cars.color, 'green')) * .returning(); * * // Delete all cars with the green color and return only their id and brand fields * const deletedCarsIdsAndBrands: { id: number, brand: string }[] = await db.delete(cars) * .where(eq(cars.color, 'green')) * .returning({ id: cars.id, brand: cars.brand }); * ``` */ returning(): PgDeleteReturningAll; returning(fields: TSelectedFields): PgDeleteReturning; toSQL(): Query; prepare(name: string): PgDeletePrepare; private authToken?; execute: ReturnType['execute']; $dynamic(): PgDeleteDynamic; }