buildWithCTE() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers called by 4

Entity Profile

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

Dependency Diagram

graph TD
  bcbd4f74_c6c7_2989_e283_a503bf2039fa["buildWithCTE()"]
  3977a3fd_2f08_73b1_4df4_3d0fd1858514["PgDialect"]
  bcbd4f74_c6c7_2989_e283_a503bf2039fa -->|defined in| 3977a3fd_2f08_73b1_4df4_3d0fd1858514
  a2e40eaa_bf7f_0455_dd07_c8fd2cf636b4["buildDeleteQuery()"]
  a2e40eaa_bf7f_0455_dd07_c8fd2cf636b4 -->|calls| bcbd4f74_c6c7_2989_e283_a503bf2039fa
  51652aaf_93cd_307b_be64_ec6b5cfd33e6["buildUpdateQuery()"]
  51652aaf_93cd_307b_be64_ec6b5cfd33e6 -->|calls| bcbd4f74_c6c7_2989_e283_a503bf2039fa
  9a7f35b1_0b1e_f3ac_68cb_233ef6bc00a0["buildSelectQuery()"]
  9a7f35b1_0b1e_f3ac_68cb_233ef6bc00a0 -->|calls| bcbd4f74_c6c7_2989_e283_a503bf2039fa
  60bfe461_a9dc_4322_6fda_a22d548a71a9["buildInsertQuery()"]
  60bfe461_a9dc_4322_6fda_a22d548a71a9 -->|calls| bcbd4f74_c6c7_2989_e283_a503bf2039fa
  style bcbd4f74_c6c7_2989_e283_a503bf2039fa fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/dialect.ts lines 126–138

	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);
	}