Home / File/ query-builder.ts — drizzle-orm Source File

query-builder.ts — drizzle-orm Source File

Architecture documentation for query-builder.ts, a typescript file in the drizzle-orm codebase. 10 imports, 3 dependents.

File typescript DrizzleORM SQLDialects 10 imports 3 dependents 1 classes

Entity Profile

Dependency Diagram

graph LR
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1["query-builder.ts"]
  beabf465_fa9a_6d7b_17f0_933ae73209d6["select.ts"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> beabf465_fa9a_6d7b_17f0_933ae73209d6
  f56e9cc8_4f98_581a_cbd1_f6264ee5715e["MySqlSelectBuilder"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> f56e9cc8_4f98_581a_cbd1_f6264ee5715e
  b145d7b0_f119_a29a_6da7_7ad4e74e20fa["select.types.ts"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> b145d7b0_f119_a29a_6da7_7ad4e74e20fa
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  8e1e9852_05bf_563a_0455_d59c9d25a84e["dialect.ts"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> 8e1e9852_05bf_563a_0455_d59c9d25a84e
  35ab40a7_c81b_5823_6384_dba35c359688["subquery.ts"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> 35ab40a7_c81b_5823_6384_dba35c359688
  d31ad410_b8fc_5d88_a194_70aa7419676a["query-builder.ts"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> d31ad410_b8fc_5d88_a194_70aa7419676a
  591617cf_1376_c0a1_4ba1_ecd59ca13a5b["selection-proxy.ts"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> 591617cf_1376_c0a1_4ba1_ecd59ca13a5b
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  4d55618d_fa7b_8e54_edb2_b85ae393d95b["subquery.ts"]
  d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 --> 4d55618d_fa7b_8e54_edb2_b85ae393d95b
  a270d70d_1a42_692c_4fcf_09f69761d58e["insert.ts"]
  a270d70d_1a42_692c_4fcf_09f69761d58e --> d3bb1ead_e032_22bd_ccef_f6b0abac6ed1
  41e24ea2_64c2_84e2_5326_1adea37e5359["subquery.ts"]
  41e24ea2_64c2_84e2_5326_1adea37e5359 --> d3bb1ead_e032_22bd_ccef_f6b0abac6ed1
  f3a29a26_df86_4100_d5ea_bc3a420b1722["view.ts"]
  f3a29a26_df86_4100_d5ea_bc3a420b1722 --> d3bb1ead_e032_22bd_ccef_f6b0abac6ed1
  style d3bb1ead_e032_22bd_ccef_f6b0abac6ed1 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind, is } from '~/entity.ts';
import type { MySqlDialectConfig } from '~/mysql-core/dialect.ts';
import { MySqlDialect } from '~/mysql-core/dialect.ts';
import type { WithBuilder } from '~/mysql-core/subquery.ts';
import type { TypedQueryBuilder } from '~/query-builders/query-builder.ts';
import { SelectionProxyHandler } from '~/selection-proxy.ts';
import type { ColumnsSelection, SQL } from '~/sql/sql.ts';
import { WithSubquery } from '~/subquery.ts';
import { MySqlSelectBuilder } from './select.ts';
import type { SelectedFields } from './select.types.ts';

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() });
	}

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

	// Lazy load dialect to avoid circular dependency
	private getDialect() {
		if (!this.dialect) {
			this.dialect = new MySqlDialect(this.dialectConfig);
		}

		return this.dialect;
	}
}

Domain

Subdomains

Classes

Dependencies

Frequently Asked Questions

What does query-builder.ts do?
query-builder.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, SQLDialects subdomain.
What does query-builder.ts depend on?
query-builder.ts imports 10 module(s): MySqlSelectBuilder, dialect.ts, entity.ts, query-builder.ts, select.ts, select.types.ts, selection-proxy.ts, sql.ts, and 2 more.
What files import query-builder.ts?
query-builder.ts is imported by 3 file(s): insert.ts, subquery.ts, view.ts.
Where is query-builder.ts in the architecture?
query-builder.ts is located at drizzle-orm/src/mysql-core/query-builders/query-builder.ts (domain: DrizzleORM, subdomain: SQLDialects, directory: drizzle-orm/src/mysql-core/query-builders).

Analyze Your Own Codebase

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

Try Supermodel Free