existing() — drizzle-orm Function Reference

Architecture documentation for the existing() function in view.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

DrizzleORM→ DatabaseDrivers→ existing() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  2bb0fa00_3bb8_5c60_fe7f_1573b3d19458["existing()"]
  07f020a4_fffb_5518_d2d8_cd96e03c64d5["ManualViewBuilder"]
  2bb0fa00_3bb8_5c60_fe7f_1573b3d19458 -->|defined in| 07f020a4_fffb_5518_d2d8_cd96e03c64d5
  style 2bb0fa00_3bb8_5c60_fe7f_1573b3d19458 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/view.ts lines 92–110

	existing(): PgViewWithSelection<TName, true, BuildColumns<TName, TColumns, 'pg'>> {
		return new Proxy(
			new PgView({
				pgConfig: undefined,
				config: {
					name: this.name,
					schema: this.schema,
					selectedFields: this.columns,
					query: undefined,
				},
			}),
			new SelectionProxyHandler({
				alias: this.name,
				sqlBehavior: 'error',
				sqlAliasedBehavior: 'alias',
				replaceOriginalName: true,
			}),
		) as PgViewWithSelection<TName, true, BuildColumns<TName, TColumns, 'pg'>>;
	}