build() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

graph TD
  8a79efe9_648b_ec96_e03d_f43cd0237ba2["build()"]
  0baeb1a9_f878_4e62_3903_d04e83bf510d["MySqlCustomColumnBuilder"]
  8a79efe9_648b_ec96_e03d_f43cd0237ba2 -->|defined in| 0baeb1a9_f878_4e62_3903_d04e83bf510d
  style 8a79efe9_648b_ec96_e03d_f43cd0237ba2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

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

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