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
  9e7877a8_9c04_8c04_0ea7_d880ebdc47af["QueryBuilder"]
  05592167_6811_c578_aecb_8ce071c602a7["query-builder.ts"]
  9e7877a8_9c04_8c04_0ea7_d880ebdc47af -->|defined in| 05592167_6811_c578_aecb_8ce071c602a7
  bd27aebf_b418_d168_dd03_5c39c412a236["constructor()"]
  9e7877a8_9c04_8c04_0ea7_d880ebdc47af -->|method| bd27aebf_b418_d168_dd03_5c39c412a236
  c9dd732c_7680_4ea5_c7ba_53b02f73357a["with()"]
  9e7877a8_9c04_8c04_0ea7_d880ebdc47af -->|method| c9dd732c_7680_4ea5_c7ba_53b02f73357a
  f37e4da7_e330_997a_e3de_843ea11fb8ff["select()"]
  9e7877a8_9c04_8c04_0ea7_d880ebdc47af -->|method| f37e4da7_e330_997a_e3de_843ea11fb8ff
  88a1564b_f138_6d8b_6ea2_471c30fda660["selectDistinct()"]
  9e7877a8_9c04_8c04_0ea7_d880ebdc47af -->|method| 88a1564b_f138_6d8b_6ea2_471c30fda660
  21e69e01_5eaf_40a7_24f2_de95f888f5cc["getDialect()"]
  9e7877a8_9c04_8c04_0ea7_d880ebdc47af -->|method| 21e69e01_5eaf_40a7_24f2_de95f888f5cc

Relationship Graph

Source Code

drizzle-orm/src/sqlite-core/query-builders/query-builder.ts lines 12–118

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

	private dialect: SQLiteDialect | undefined;
	private dialectConfig: SQLiteDialectConfig | undefined;

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

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

		return { select, selectDistinct };
	}

	select(): SQLiteSelectBuilder<undefined, 'sync', void, 'qb'>;
	select<TSelection extends SelectedFields>(
		fields: TSelection,
	): SQLiteSelectBuilder<TSelection, 'sync', void, 'qb'>;
	select<TSelection extends SelectedFields>(
		fields?: TSelection,
	): SQLiteSelectBuilder<TSelection | undefined, 'sync', void, 'qb'> {
		return new SQLiteSelectBuilder({ 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/sqlite-core/query-builders/query-builder.ts.
Where is QueryBuilder defined?
QueryBuilder is defined in drizzle-orm/src/sqlite-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