drizzle-orm Architecture Docs
Home / Type/ WithBuilder Type — drizzle-orm Architecture

WithBuilder Type — drizzle-orm Architecture

Architecture documentation for the WithBuilder type/interface in subquery.ts from the drizzle-orm codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  b3f3c370_b132_a712_3902_7428c5b56bb5["WithBuilder"]
  41e24ea2_64c2_84e2_5326_1adea37e5359["subquery.ts"]
  b3f3c370_b132_a712_3902_7428c5b56bb5 -->|defined in| 41e24ea2_64c2_84e2_5326_1adea37e5359
  style b3f3c370_b132_a712_3902_7428c5b56bb5 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/subquery.ts lines 21–35

export interface WithBuilder {
	<TAlias extends string>(alias: TAlias): {
		as: {
			<TSelection extends ColumnsSelection>(
				qb: TypedQueryBuilder<TSelection> | ((qb: QueryBuilder) => TypedQueryBuilder<TSelection>),
			): WithSubqueryWithSelection<TSelection, TAlias>;
			(
				qb: TypedQueryBuilder<undefined> | ((qb: QueryBuilder) => TypedQueryBuilder<undefined>),
			): WithSubqueryWithoutSelection<TAlias>;
		};
	};
	<TAlias extends string, TSelection extends ColumnsSelection>(alias: TAlias, selection: TSelection): {
		as: (qb: SQL | ((qb: QueryBuilder) => SQL)) => WithSubqueryWithSelection<TSelection, TAlias>;
	};
}

Defined In

Source

Frequently Asked Questions

What is the WithBuilder type?
WithBuilder is a type/interface in the drizzle-orm codebase, defined in drizzle-orm/src/mysql-core/subquery.ts.
Where is WithBuilder defined?
WithBuilder is defined in drizzle-orm/src/mysql-core/subquery.ts at line 21.

Analyze Your Own Codebase

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

Try Supermodel Free