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

MySqlCustomColumnBuilder Class — drizzle-orm Architecture

Architecture documentation for the MySqlCustomColumnBuilder class in custom.ts from the drizzle-orm codebase.

Class typescript DrizzleORM

Entity Profile

Dependency Diagram

graph TD
  0baeb1a9_f878_4e62_3903_d04e83bf510d["MySqlCustomColumnBuilder"]
  93e79285_19cd_4939_7e23_416703743740["custom.ts"]
  0baeb1a9_f878_4e62_3903_d04e83bf510d -->|defined in| 93e79285_19cd_4939_7e23_416703743740
  f07dd2d8_5f23_811a_af9b_2852efd2543f["constructor()"]
  0baeb1a9_f878_4e62_3903_d04e83bf510d -->|method| f07dd2d8_5f23_811a_af9b_2852efd2543f
  8a79efe9_648b_ec96_e03d_f43cd0237ba2["build()"]
  0baeb1a9_f878_4e62_3903_d04e83bf510d -->|method| 8a79efe9_648b_ec96_e03d_f43cd0237ba2

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/columns/custom.ts lines 25–58

export class MySqlCustomColumnBuilder<T extends ColumnBuilderBaseConfig<'custom', 'MySqlCustomColumn'>>
	extends MySqlColumnBuilder<
		T,
		{
			fieldConfig: CustomTypeValues['config'];
			customTypeParams: CustomTypeParams<any>;
		},
		{
			mysqlColumnBuilderBrand: 'MySqlCustomColumnBuilderBrand';
		}
	>
{
	static override readonly [entityKind]: string = 'MySqlCustomColumnBuilder';

	constructor(
		name: T['name'],
		fieldConfig: CustomTypeValues['config'],
		customTypeParams: CustomTypeParams<any>,
	) {
		super(name, 'custom', 'MySqlCustomColumn');
		this.config.fieldConfig = fieldConfig;
		this.config.customTypeParams = customTypeParams;
	}

	/** @internal */
	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>,
		);
	}
}

Domain

Defined In

Source

Frequently Asked Questions

What is the MySqlCustomColumnBuilder class?
MySqlCustomColumnBuilder is a class in the drizzle-orm codebase, defined in drizzle-orm/src/mysql-core/columns/custom.ts.
Where is MySqlCustomColumnBuilder defined?
MySqlCustomColumnBuilder is defined in drizzle-orm/src/mysql-core/columns/custom.ts at line 25.

Analyze Your Own Codebase

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

Try Supermodel Free