drizzle-orm Architecture Docs
Home / Class/ QueryBuilder Class — drizzle-orm Architecture

QueryBuilder Class — drizzle-orm Architecture

Architecture documentation for the QueryBuilder class in query-builder.ts from the drizzle-orm codebase.

Class typescript DrizzleORM

Entity Profile

Dependency Diagram

graph TD
  6fbf8d35_ebd1_2ae8_988d_1aa0127184d7["QueryBuilder"]
  07dd6b3b_dc76_a449_419f_d180e820b911["query-builder.ts"]
  6fbf8d35_ebd1_2ae8_988d_1aa0127184d7 -->|defined in| 07dd6b3b_dc76_a449_419f_d180e820b911
  9604a391_e3bc_aa61_07dd_fb5c5c4db89b["constructor()"]
  6fbf8d35_ebd1_2ae8_988d_1aa0127184d7 -->|method| 9604a391_e3bc_aa61_07dd_fb5c5c4db89b
  90ba8c63_f6a6_19d5_1d1b_6107168e1b11["with()"]
  6fbf8d35_ebd1_2ae8_988d_1aa0127184d7 -->|method| 90ba8c63_f6a6_19d5_1d1b_6107168e1b11
  502f7d78_34ca_ceed_c13d_1f2af07bfe4d["select()"]
  6fbf8d35_ebd1_2ae8_988d_1aa0127184d7 -->|method| 502f7d78_34ca_ceed_c13d_1f2af07bfe4d
  dd3bb78c_6c2c_04a1_40a0_5a208b4095d1["selectDistinct()"]
  6fbf8d35_ebd1_2ae8_988d_1aa0127184d7 -->|method| dd3bb78c_6c2c_04a1_40a0_5a208b4095d1
  15a9ca00_acf3_2d01_1c77_d5d617494580["selectDistinctOn()"]
  6fbf8d35_ebd1_2ae8_988d_1aa0127184d7 -->|method| 15a9ca00_acf3_2d01_1c77_d5d617494580
  d8856c59_05df_b1bb_72e8_74514a2ed20b["getDialect()"]
  6fbf8d35_ebd1_2ae8_988d_1aa0127184d7 -->|method| d8856c59_05df_b1bb_72e8_74514a2ed20b

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/query-builder.ts lines 13–144

export class QueryBuilder {
	static readonly [entityKind]: string = 'PgQueryBuilder';

	private dialect: PgDialect | undefined;
	private dialectConfig: PgDialectConfig | undefined;

	constructor(dialect?: PgDialect | PgDialectConfig) {
		this.dialect = is(dialect, PgDialect) ? dialect : undefined;
		this.dialectConfig = is(dialect, PgDialect) ? undefined : dialect;
	}

	$with: WithBuilder = (alias: string, selection?: ColumnsSelection) => {
		const queryBuilder = this;
		const as = (
			qb:
				| TypedQueryBuilder<ColumnsSelection | undefined>
				| SQL
				| ((qb: QueryBuilder) => TypedQueryBuilder<ColumnsSelection | undefined> | SQL),
		) => {
			if (typeof qb === 'function') {
				qb = qb(queryBuilder);
			}

			return new Proxy(
				new WithSubquery(
					qb.getSQL(),
					selection ?? ('getSelectedFields' in qb ? qb.getSelectedFields() ?? {} : {}) as SelectedFields,
					alias,
					true,
				),
				new SelectionProxyHandler({ alias, sqlAliasedBehavior: 'alias', sqlBehavior: 'error' }),
			) as any;
		};
		return { as };
	};

	with(...queries: WithSubquery[]) {
		const self = this;

		function select(): PgSelectBuilder<undefined, 'qb'>;
		function select<TSelection extends SelectedFields>(fields: TSelection): PgSelectBuilder<TSelection, 'qb'>;
		function select<TSelection extends SelectedFields>(
			fields?: TSelection,
		): PgSelectBuilder<TSelection | undefined, 'qb'> {
			return new PgSelectBuilder({
				fields: fields ?? undefined,
				session: undefined,
				dialect: self.getDialect(),
				withList: queries,
			});
		}

		function selectDistinct(): PgSelectBuilder<undefined, 'qb'>;
		function selectDistinct<TSelection extends SelectedFields>(fields: TSelection): PgSelectBuilder<TSelection, 'qb'>;
		function selectDistinct<TSelection extends SelectedFields>(
			fields?: TSelection,
		): PgSelectBuilder<TSelection | undefined, 'qb'> {
			return new PgSelectBuilder({
				fields: fields ?? undefined,
				session: undefined,
				dialect: self.getDialect(),
				distinct: true,
			});
		}

		function selectDistinctOn(on: (PgColumn | SQLWrapper)[]): PgSelectBuilder<undefined, 'qb'>;
		function selectDistinctOn<TSelection extends SelectedFields>(
			on: (PgColumn | SQLWrapper)[],
			fields: TSelection,
		): PgSelectBuilder<TSelection, 'qb'>;
		function selectDistinctOn<TSelection extends SelectedFields>(
			on: (PgColumn | SQLWrapper)[],
			fields?: TSelection,
		): PgSelectBuilder<TSelection | undefined, 'qb'> {
			return new PgSelectBuilder({
				fields: fields ?? undefined,
				session: undefined,
				dialect: self.getDialect(),
				distinct: { on },
			});
		}

Domain

Defined In

Source

Frequently Asked Questions

What is the QueryBuilder class?
QueryBuilder is a class in the drizzle-orm codebase, defined in drizzle-orm/src/pg-core/query-builders/query-builder.ts.
Where is QueryBuilder defined?
QueryBuilder is defined in drizzle-orm/src/pg-core/query-builders/query-builder.ts at line 13.

Analyze Your Own Codebase

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

Try Supermodel Free