drizzle-orm Architecture Docs
Home / Class/ ViewBuilder Class — drizzle-orm Architecture

ViewBuilder Class — drizzle-orm Architecture

Architecture documentation for the ViewBuilder class in view.ts from the drizzle-orm codebase.

Class typescript DrizzleORM

Entity Profile

Dependency Diagram

graph TD
  6ca59ca1_2408_7f86_2c07_ceb7bbc97289["ViewBuilder"]
  a44cb974_fe5a_c572_a91a_51fe8c82034c["view.ts"]
  6ca59ca1_2408_7f86_2c07_ceb7bbc97289 -->|defined in| a44cb974_fe5a_c572_a91a_51fe8c82034c
  5a7db7a7_5a13_75b6_6d80_3e1cceea0ee2["as()"]
  6ca59ca1_2408_7f86_2c07_ceb7bbc97289 -->|method| 5a7db7a7_5a13_75b6_6d80_3e1cceea0ee2

Relationship Graph

Source Code

drizzle-orm/src/pg-core/view.ts lines 44–73

export class ViewBuilder<TName extends string = string> extends DefaultViewBuilderCore<{ name: TName }> {
	static override readonly [entityKind]: string = 'PgViewBuilder';

	as<TSelectedFields extends ColumnsSelection>(
		qb: TypedQueryBuilder<TSelectedFields> | ((qb: QueryBuilder) => TypedQueryBuilder<TSelectedFields>),
	): PgViewWithSelection<TName, false, AddAliasToSelection<TSelectedFields, TName, 'pg'>> {
		if (typeof qb === 'function') {
			qb = qb(new QueryBuilder());
		}
		const selectionProxy = new SelectionProxyHandler<TSelectedFields>({
			alias: this.name,
			sqlBehavior: 'error',
			sqlAliasedBehavior: 'alias',
			replaceOriginalName: true,
		});
		const aliasedSelection = new Proxy(qb.getSelectedFields(), selectionProxy);
		return new Proxy(
			new PgView({
				pgConfig: this.config,
				config: {
					name: this.name,
					schema: this.schema,
					selectedFields: aliasedSelection,
					query: qb.getSQL().inlineParams(),
				},
			}),
			selectionProxy as any,
		) as PgViewWithSelection<TName, false, AddAliasToSelection<TSelectedFields, TName, 'pg'>>;
	}
}

Domain

Defined In

Source

Frequently Asked Questions

What is the ViewBuilder class?
ViewBuilder is a class in the drizzle-orm codebase, defined in drizzle-orm/src/pg-core/view.ts.
Where is ViewBuilder defined?
ViewBuilder is defined in drizzle-orm/src/pg-core/view.ts at line 44.

Analyze Your Own Codebase

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

Try Supermodel Free