Home / Function/ buildDeleteQuery() — drizzle-orm Function Reference

buildDeleteQuery() — drizzle-orm Function Reference

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

Entity Profile

Dependency Diagram

graph TD
  6603fb43_ff6f_ad94_0e94_0f152d804075["buildDeleteQuery()"]
  9c5eee4c_4b78_a585_4038_d710de212097["MySqlDialect"]
  6603fb43_ff6f_ad94_0e94_0f152d804075 -->|defined in| 9c5eee4c_4b78_a585_4038_d710de212097
  36b61a5b_7f68_2e43_5760_d461578993f6["buildWithCTE()"]
  6603fb43_ff6f_ad94_0e94_0f152d804075 -->|calls| 36b61a5b_7f68_2e43_5760_d461578993f6
  d2bb0977_2845_5bd0_d019_e55f619ef7e8["buildSelection()"]
  6603fb43_ff6f_ad94_0e94_0f152d804075 -->|calls| d2bb0977_2845_5bd0_d019_e55f619ef7e8
  1a6d3dd7_66dd_323c_34ba_58c1bebc1ede["buildOrderBy()"]
  6603fb43_ff6f_ad94_0e94_0f152d804075 -->|calls| 1a6d3dd7_66dd_323c_34ba_58c1bebc1ede
  6b198fad_61da_d3c6_6497_9634ac05c48a["buildLimit()"]
  6603fb43_ff6f_ad94_0e94_0f152d804075 -->|calls| 6b198fad_61da_d3c6_6497_9634ac05c48a
  style 6603fb43_ff6f_ad94_0e94_0f152d804075 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/dialect.ts lines 120–134

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

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

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

		const orderBySql = this.buildOrderBy(orderBy);

		const limitSql = this.buildLimit(limit);

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

Domain

Subdomains

Frequently Asked Questions

What does buildDeleteQuery() do?
buildDeleteQuery() is a function in the drizzle-orm codebase, defined in drizzle-orm/src/mysql-core/dialect.ts.
Where is buildDeleteQuery() defined?
buildDeleteQuery() is defined in drizzle-orm/src/mysql-core/dialect.ts at line 120.
What does buildDeleteQuery() call?
buildDeleteQuery() calls 4 function(s): buildLimit, buildOrderBy, buildSelection, buildWithCTE.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free