buildWithCTE() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects called by 4

Entity Profile

DrizzleORM→ SQLDialects→ buildWithCTE() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  508f5cc1_d856_0ba4_7831_119c8e91ea8f["buildWithCTE()"]
  f80973ef_149c_bd36_66ee_1e7e9024a9d5["GelDialect"]
  508f5cc1_d856_0ba4_7831_119c8e91ea8f -->|defined in| f80973ef_149c_bd36_66ee_1e7e9024a9d5
  79a2c90c_d895_083e_e194_a2cb1d365c8e["buildDeleteQuery()"]
  79a2c90c_d895_083e_e194_a2cb1d365c8e -->|calls| 508f5cc1_d856_0ba4_7831_119c8e91ea8f
  b6dba0b8_7a2e_9652_d94a_4567bdbe1d3b["buildUpdateQuery()"]
  b6dba0b8_7a2e_9652_d94a_4567bdbe1d3b -->|calls| 508f5cc1_d856_0ba4_7831_119c8e91ea8f
  6a5af19b_779e_e705_f0b0_c71ea6c700fd["buildSelectQuery()"]
  6a5af19b_779e_e705_f0b0_c71ea6c700fd -->|calls| 508f5cc1_d856_0ba4_7831_119c8e91ea8f
  0396b741_ac98_c02e_ce6b_3b28587ddc46["buildInsertQuery()"]
  0396b741_ac98_c02e_ce6b_3b28587ddc46 -->|calls| 508f5cc1_d856_0ba4_7831_119c8e91ea8f
  style 508f5cc1_d856_0ba4_7831_119c8e91ea8f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/gel-core/dialect.ts lines 115–127

	private buildWithCTE(queries: Subquery[] | undefined): SQL | undefined {
		if (!queries?.length) return undefined;

		const withSqlChunks = [sql`with `];
		for (const [i, w] of queries.entries()) {
			withSqlChunks.push(sql`${sql.identifier(w._.alias)} as (${w._.sql})`);
			if (i < queries.length - 1) {
				withSqlChunks.push(sql`, `);
			}
		}
		withSqlChunks.push(sql` `);
		return sql.join(withSqlChunks);
	}