$with() — drizzle-orm Function Reference

Architecture documentation for the $with() function in query-builder.ts from the drizzle-orm codebase.

Function typescript DrizzleORM QueryBuilders

Entity Profile

DrizzleORM→ QueryBuilders→ $with() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  e95e4155_9cea_5297_70d3_53ed0fbf9e65["$with()"]
  4d1210ae_09b8_d3bc_6c8e_d393ccd84bdd["QueryBuilder"]
  e95e4155_9cea_5297_70d3_53ed0fbf9e65 -->|defined in| 4d1210ae_09b8_d3bc_6c8e_d393ccd84bdd
  style e95e4155_9cea_5297_70d3_53ed0fbf9e65 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/gel-core/query-builders/query-builder.ts lines 24–41

	$with<TAlias extends string>(alias: TAlias) {
		const queryBuilder = this;

		return {
			as<TSelection extends ColumnsSelection>(
				qb: TypedQueryBuilder<TSelection> | ((qb: QueryBuilder) => TypedQueryBuilder<TSelection>),
			): WithSubqueryWithSelection<TSelection, TAlias> {
				if (typeof qb === 'function') {
					qb = qb(queryBuilder);
				}

				return new Proxy(
					new WithSubquery(qb.getSQL(), qb.getSelectedFields() as SelectedFields, alias, true),
					new SelectionProxyHandler({ alias, sqlAliasedBehavior: 'alias', sqlBehavior: 'error' }),
				) as WithSubqueryWithSelection<TSelection, TAlias>;
			},
		};
	}