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. 11 imports, 3 dependents.

File typescript DrizzleORM QueryBuilders 11 imports 3 dependents 1 classes

Entity Profile

Dependency Diagram

graph LR
  07dd6b3b_dc76_a449_419f_d180e820b911["query-builder.ts"]
  b5f68e91_0c18_4699_4724_dcbb5d28898e["index.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> b5f68e91_0c18_4699_4724_dcbb5d28898e
  2f61feb4_8de9_0737_895f_3ed46c146b33["subquery.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> 2f61feb4_8de9_0737_895f_3ed46c146b33
  50a440a3_419f_74a4_a0ef_a8f58a685eb0["select.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> 50a440a3_419f_74a4_a0ef_a8f58a685eb0
  6821233b_77bc_4757_b1f2_448aa2353293["PgSelectBuilder"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> 6821233b_77bc_4757_b1f2_448aa2353293
  65d45edf_0d8a_b7f0_1780_573c12d9a0e6["select.types.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> 65d45edf_0d8a_b7f0_1780_573c12d9a0e6
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  65dc222f_bc11_439f_d65b_20d7052b24ec["dialect.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> 65dc222f_bc11_439f_d65b_20d7052b24ec
  d31ad410_b8fc_5d88_a194_70aa7419676a["query-builder.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> d31ad410_b8fc_5d88_a194_70aa7419676a
  591617cf_1376_c0a1_4ba1_ecd59ca13a5b["selection-proxy.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> 591617cf_1376_c0a1_4ba1_ecd59ca13a5b
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  4d55618d_fa7b_8e54_edb2_b85ae393d95b["subquery.ts"]
  07dd6b3b_dc76_a449_419f_d180e820b911 --> 4d55618d_fa7b_8e54_edb2_b85ae393d95b
  6f066777_3f37_e9b7_9d78_03e1a3ea895d["insert.ts"]
  6f066777_3f37_e9b7_9d78_03e1a3ea895d --> 07dd6b3b_dc76_a449_419f_d180e820b911
  2f61feb4_8de9_0737_895f_3ed46c146b33["subquery.ts"]
  2f61feb4_8de9_0737_895f_3ed46c146b33 --> 07dd6b3b_dc76_a449_419f_d180e820b911
  a44cb974_fe5a_c572_a91a_51fe8c82034c["view.ts"]
  a44cb974_fe5a_c572_a91a_51fe8c82034c --> 07dd6b3b_dc76_a449_419f_d180e820b911
  style 07dd6b3b_dc76_a449_419f_d180e820b911 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind, is } from '~/entity.ts';
import type { PgDialectConfig } from '~/pg-core/dialect.ts';
import { PgDialect } from '~/pg-core/dialect.ts';
import type { TypedQueryBuilder } from '~/query-builders/query-builder.ts';
import { SelectionProxyHandler } from '~/selection-proxy.ts';
import type { ColumnsSelection, SQL, SQLWrapper } from '~/sql/sql.ts';
import { WithSubquery } from '~/subquery.ts';
import type { PgColumn } from '../columns/index.ts';
import type { WithBuilder } from '../subquery.ts';
import { PgSelectBuilder } from './select.ts';
import type { SelectedFields } from './select.types.ts';

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

	private dialect: PgDialect | undefined;
	private dialectConfig: PgDialectConfig | undefined;

	constructor(dialect?: PgDialect | PgDialectConfig) {
		this.dialect = is(dialect, PgDialect) ? dialect : undefined;
		this.dialectConfig = is(dialect, PgDialect) ? 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(): PgSelectBuilder<undefined, 'qb'>;
		function select<TSelection extends SelectedFields>(fields: TSelection): PgSelectBuilder<TSelection, 'qb'>;
		function select<TSelection extends SelectedFields>(
			fields?: TSelection,
		): PgSelectBuilder<TSelection | undefined, 'qb'> {
			return new PgSelectBuilder({
				fields: fields ?? undefined,
				session: undefined,
				dialect: self.getDialect(),
// ... (85 more lines)

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, QueryBuilders subdomain.
What does query-builder.ts depend on?
query-builder.ts imports 11 module(s): PgSelectBuilder, dialect.ts, entity.ts, index.ts, query-builder.ts, select.ts, select.types.ts, selection-proxy.ts, and 3 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/pg-core/query-builders/query-builder.ts (domain: DrizzleORM, subdomain: QueryBuilders, directory: drizzle-orm/src/pg-core/query-builders).

Analyze Your Own Codebase

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

Try Supermodel Free