existing() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/view.ts lines 105–123

	existing(): MySqlViewWithSelection<TName, true, BuildColumns<TName, TColumns, 'mysql'>> {
		return new Proxy(
			new MySqlView({
				mysqlConfig: 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 MySqlViewWithSelection<TName, true, BuildColumns<TName, TColumns, 'mysql'>>;
	}