build() — drizzle-orm Function Reference

Architecture documentation for the build() function in custom.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

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

Dependency Diagram

graph TD
  32367b4e_74b0_03fd_5321_63ee1db574bd["build()"]
  3ab2fad2_bd5c_f94c_01b0_7a6ff24eeb86["PgCustomColumnBuilder"]
  32367b4e_74b0_03fd_5321_63ee1db574bd -->|defined in| 3ab2fad2_bd5c_f94c_01b0_7a6ff24eeb86
  style 32367b4e_74b0_03fd_5321_63ee1db574bd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/columns/custom.ts lines 50–57

	build<TTableName extends string>(
		table: AnyPgTable<{ name: TTableName }>,
	): PgCustomColumn<MakeColumnConfig<T, TTableName>> {
		return new PgCustomColumn<MakeColumnConfig<T, TTableName>>(
			table,
			this.config as ColumnBuilderRuntimeConfig<any, any>,
		);
	}