UNPKG

drizzle-orm

Version:

Drizzle ORM package for SQL databases

85 lines 2.57 kB
import { entityKind } from "../../entity.js"; import { QueryPromise } from "../../query-promise.js"; import { Table } from "../../table.js"; import { tracer } from "../../tracing.js"; import { orderSelectedFields } from "../../utils.js"; import { extractUsedTable } from "../utils.js"; class GelDeleteBase extends QueryPromise { constructor(table, session, dialect, withList) { super(); this.session = session; this.dialect = dialect; this.config = { table, withList }; } static [entityKind] = "GelDelete"; config; /** * 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) { this.config.where = where; return this; } returning(fields = this.config.table[Table.Symbol.Columns]) { this.config.returning = orderSelectedFields(fields); return this; } /** @internal */ getSQL() { return this.dialect.buildDeleteQuery(this.config); } toSQL() { const { typings: _typings, ...rest } = this.dialect.sqlToQuery(this.getSQL()); return rest; } /** @internal */ _prepare(name) { return tracer.startActiveSpan("drizzle.prepareQuery", () => { return this.session.prepareQuery(this.dialect.sqlToQuery(this.getSQL()), this.config.returning, name, true, void 0, { type: "delete", tables: extractUsedTable(this.config.table) }); }); } prepare(name) { return this._prepare(name); } execute = (placeholderValues) => { return tracer.startActiveSpan("drizzle.operation", () => { return this._prepare().execute(placeholderValues); }); }; $dynamic() { return this; } } export { GelDeleteBase }; //# sourceMappingURL=delete.js.map