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
  05592167_6811_c578_aecb_8ce071c602a7["query-builder.ts"]
  49cf912b_062f_f482_ab61_a2b8c881ec4d["select.ts"]
  05592167_6811_c578_aecb_8ce071c602a7 --> 49cf912b_062f_f482_ab61_a2b8c881ec4d
  7fe0b35a_8afa_0082_ace8_8c071ed2ece2["SQLiteSelectBuilder"]
  05592167_6811_c578_aecb_8ce071c602a7 --> 7fe0b35a_8afa_0082_ace8_8c071ed2ece2
  18a5fcd5_994e_4f8e_c531_decae9341796["select.types.ts"]
  05592167_6811_c578_aecb_8ce071c602a7 --> 18a5fcd5_994e_4f8e_c531_decae9341796
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  05592167_6811_c578_aecb_8ce071c602a7 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  d31ad410_b8fc_5d88_a194_70aa7419676a["query-builder.ts"]
  05592167_6811_c578_aecb_8ce071c602a7 --> d31ad410_b8fc_5d88_a194_70aa7419676a
  591617cf_1376_c0a1_4ba1_ecd59ca13a5b["selection-proxy.ts"]
  05592167_6811_c578_aecb_8ce071c602a7 --> 591617cf_1376_c0a1_4ba1_ecd59ca13a5b
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  05592167_6811_c578_aecb_8ce071c602a7 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  05592167_6811_c578_aecb_8ce071c602a7 --> 3d205d67_2ef4_984a_3241_ff4981527231
  02724f97_00cc_4744_d7bc_904f3d2ea976["subquery.ts"]
  05592167_6811_c578_aecb_8ce071c602a7 --> 02724f97_00cc_4744_d7bc_904f3d2ea976
  4d55618d_fa7b_8e54_edb2_b85ae393d95b["subquery.ts"]
  05592167_6811_c578_aecb_8ce071c602a7 --> 4d55618d_fa7b_8e54_edb2_b85ae393d95b
  84987318_b83b_9a2c_d793_542fa0b46175["insert.ts"]
  84987318_b83b_9a2c_d793_542fa0b46175 --> 05592167_6811_c578_aecb_8ce071c602a7
  69c14b95_3001_2f9c_64fa_d818657b1132["subquery.ts"]
  69c14b95_3001_2f9c_64fa_d818657b1132 --> 05592167_6811_c578_aecb_8ce071c602a7
  d25d55b4_d8a4_6f19_2b5c_2ef3a5375746["view.ts"]
  d25d55b4_d8a4_6f19_2b5c_2ef3a5375746 --> 05592167_6811_c578_aecb_8ce071c602a7
  style 05592167_6811_c578_aecb_8ce071c602a7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind, is } from '~/entity.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 type { SQLiteDialectConfig } from '~/sqlite-core/dialect.ts';
import { SQLiteDialect, SQLiteSyncDialect } from '~/sqlite-core/dialect.ts';
import type { WithBuilder } from '~/sqlite-core/subquery.ts';
import { WithSubquery } from '~/subquery.ts';
import { SQLiteSelectBuilder } from './select.ts';
import type { SelectedFields } from './select.types.ts';

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

	selectDistinct(): SQLiteSelectBuilder<undefined, 'sync', void, 'qb'>;
	selectDistinct<TSelection extends SelectedFields>(
		fields: TSelection,
	): SQLiteSelectBuilder<TSelection, 'sync', void, 'qb'>;
	selectDistinct<TSelection extends SelectedFields>(
		fields?: TSelection,
	): SQLiteSelectBuilder<TSelection | undefined, 'sync', void, 'qb'> {
		return new SQLiteSelectBuilder({
			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 SQLiteSyncDialect(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): SQLiteSelectBuilder, 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/sqlite-core/query-builders/query-builder.ts (domain: DrizzleORM, subdomain: SQLDialects, directory: drizzle-orm/src/sqlite-core/query-builders).

Analyze Your Own Codebase

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

Try Supermodel Free