buildDeleteQuery() — drizzle-orm Function Reference

Architecture documentation for the buildDeleteQuery() function in dialect.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers calls 2

Entity Profile

DrizzleORM→ DatabaseDrivers→ buildDeleteQuery() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  a2e40eaa_bf7f_0455_dd07_c8fd2cf636b4["buildDeleteQuery()"]
  3977a3fd_2f08_73b1_4df4_3d0fd1858514["PgDialect"]
  a2e40eaa_bf7f_0455_dd07_c8fd2cf636b4 -->|defined in| 3977a3fd_2f08_73b1_4df4_3d0fd1858514
  bcbd4f74_c6c7_2989_e283_a503bf2039fa["buildWithCTE()"]
  a2e40eaa_bf7f_0455_dd07_c8fd2cf636b4 -->|calls| bcbd4f74_c6c7_2989_e283_a503bf2039fa
  e700cd38_c0c8_fbeb_26a9_7fbf17216117["buildSelection()"]
  a2e40eaa_bf7f_0455_dd07_c8fd2cf636b4 -->|calls| e700cd38_c0c8_fbeb_26a9_7fbf17216117
  style a2e40eaa_bf7f_0455_dd07_c8fd2cf636b4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/dialect.ts lines 140–150

	buildDeleteQuery({ table, where, returning, withList }: PgDeleteConfig): SQL {
		const withSql = this.buildWithCTE(withList);

		const returningSql = returning
			? sql` returning ${this.buildSelection(returning, { isSingleTable: true })}`
			: undefined;

		const whereSql = where ? sql` where ${where}` : undefined;

		return sql`${withSql}delete from ${table}${whereSql}${returningSql}`;
	}