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
  f16aff3b_55c4_db12_2433_7a70fdaa6add["QueryBuilder"]
  85b4eb2c_30da_7542_712e_b0bce0c3c73d["query-builder.ts"]
  f16aff3b_55c4_db12_2433_7a70fdaa6add -->|defined in| 85b4eb2c_30da_7542_712e_b0bce0c3c73d
  a03bfb5c_014f_1c52_d1b1_3e6a8720c826["constructor()"]
  f16aff3b_55c4_db12_2433_7a70fdaa6add -->|method| a03bfb5c_014f_1c52_d1b1_3e6a8720c826
  58178f00_525e_646e_92bd_d5a011935635["with()"]
  f16aff3b_55c4_db12_2433_7a70fdaa6add -->|method| 58178f00_525e_646e_92bd_d5a011935635
  f3830e4c_daa3_5972_1fca_b4ef3ec8cb2a["select()"]
  f16aff3b_55c4_db12_2433_7a70fdaa6add -->|method| f3830e4c_daa3_5972_1fca_b4ef3ec8cb2a
  bdaf35a6_3daf_2bb0_42ac_feb4dc368943["selectDistinct()"]
  f16aff3b_55c4_db12_2433_7a70fdaa6add -->|method| bdaf35a6_3daf_2bb0_42ac_feb4dc368943
  4a70fdd4_bacd_e7e2_8c1b_4b852ed1a924["getDialect()"]
  f16aff3b_55c4_db12_2433_7a70fdaa6add -->|method| 4a70fdd4_bacd_e7e2_8c1b_4b852ed1a924

Relationship Graph

Source Code

drizzle-orm/src/singlestore-core/query-builders/query-builder.ts lines 12–120

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

	private dialect: SingleStoreDialect | undefined;
	private dialectConfig: SingleStoreDialectConfig | undefined;

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

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

		return { select, selectDistinct };
	}

	select(): SingleStoreSelectBuilder<undefined, never, 'qb'>;
	select<TSelection extends SelectedFields>(fields: TSelection): SingleStoreSelectBuilder<TSelection, never, 'qb'>;
	select<TSelection extends SelectedFields>(
		fields?: TSelection,
	): SingleStoreSelectBuilder<TSelection | undefined, never, 'qb'> {
		return new SingleStoreSelectBuilder({
			fields: fields ?? undefined,
			session: undefined,

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