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
  dee3e8ac_d7af_d07c_18f4_417182ce53f3["QueryBuilder"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1["query-builder.ts"]
  dee3e8ac_d7af_d07c_18f4_417182ce53f3 -->|defined in| d3bb1ead_e032_22bd_ccef_f6b0abac6ed1
  a7fb4bb6_1b58_2bcd_9b26_b61d0788c30b["constructor()"]
  dee3e8ac_d7af_d07c_18f4_417182ce53f3 -->|method| a7fb4bb6_1b58_2bcd_9b26_b61d0788c30b
  bc9c1bfa_5d66_ec03_7aff_509eb90539d3["with()"]
  dee3e8ac_d7af_d07c_18f4_417182ce53f3 -->|method| bc9c1bfa_5d66_ec03_7aff_509eb90539d3
  7ae54d28_15e5_83bb_326a_989d6878f163["select()"]
  dee3e8ac_d7af_d07c_18f4_417182ce53f3 -->|method| 7ae54d28_15e5_83bb_326a_989d6878f163
  2ca2c85c_c504_cb0f_8af6_6b4f9f11b4c0["selectDistinct()"]
  dee3e8ac_d7af_d07c_18f4_417182ce53f3 -->|method| 2ca2c85c_c504_cb0f_8af6_6b4f9f11b4c0
  fdc0c859_068c_5ce9_e13c_53a3fafb56fd["getDialect()"]
  dee3e8ac_d7af_d07c_18f4_417182ce53f3 -->|method| fdc0c859_068c_5ce9_e13c_53a3fafb56fd

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/query-builders/query-builder.ts lines 12–116

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

	private dialect: MySqlDialect | undefined;
	private dialectConfig: MySqlDialectConfig | undefined;

	constructor(dialect?: MySqlDialect | MySqlDialectConfig) {
		this.dialect = is(dialect, MySqlDialect) ? dialect : undefined;
		this.dialectConfig = is(dialect, MySqlDialect) ? 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(): MySqlSelectBuilder<undefined, never, 'qb'>;
		function select<TSelection extends SelectedFields>(
			fields: TSelection,
		): MySqlSelectBuilder<TSelection, never, 'qb'>;
		function select<TSelection extends SelectedFields>(
			fields?: TSelection,
		): MySqlSelectBuilder<TSelection | undefined, never, 'qb'> {
			return new MySqlSelectBuilder({
				fields: fields ?? undefined,
				session: undefined,
				dialect: self.getDialect(),
				withList: queries,
			});
		}

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

		return { select, selectDistinct };
	}

	select(): MySqlSelectBuilder<undefined, never, 'qb'>;
	select<TSelection extends SelectedFields>(fields: TSelection): MySqlSelectBuilder<TSelection, never, 'qb'>;
	select<TSelection extends SelectedFields>(
		fields?: TSelection,
	): MySqlSelectBuilder<TSelection | undefined, never, 'qb'> {
		return new MySqlSelectBuilder({ fields: fields ?? undefined, session: undefined, dialect: this.getDialect() });
	}

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/mysql-core/query-builders/query-builder.ts.
Where is QueryBuilder defined?
QueryBuilder is defined in drizzle-orm/src/mysql-core/query-builders/query-builder.ts at line 12.

Analyze Your Own Codebase

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

Try Supermodel Free