drizzle-orm Architecture Docs
Home / File/ enum.ts — drizzle-orm Source File

enum.ts — drizzle-orm Source File

Architecture documentation for enum.ts, a typescript file in the drizzle-orm codebase. 7 imports, 1 dependents.

File typescript DrizzleORM SQLDialects 7 imports 1 dependents 1 functions 4 classes

Entity Profile

Dependency Diagram

graph LR
  48523f49_1f0c_29c3_f64b_e37fdb914c83["enum.ts"]
  83c65ad5_22a0_d33f_47b8_c2ed1c8d8bbb["common.ts"]
  48523f49_1f0c_29c3_f64b_e37fdb914c83 --> 83c65ad5_22a0_d33f_47b8_c2ed1c8d8bbb
  8da43de9_1be1_48fb_1db1_a6bc59f5b306["MySqlColumn"]
  48523f49_1f0c_29c3_f64b_e37fdb914c83 --> 8da43de9_1be1_48fb_1db1_a6bc59f5b306
  2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"]
  48523f49_1f0c_29c3_f64b_e37fdb914c83 --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426
  05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"]
  48523f49_1f0c_29c3_f64b_e37fdb914c83 --> 05f0a280_d0c9_693a_a4bf_83cc671012d2
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  48523f49_1f0c_29c3_f64b_e37fdb914c83 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  70e1783e_f575_ccd4_36bd_5f0978c2172c["table.ts"]
  48523f49_1f0c_29c3_f64b_e37fdb914c83 --> 70e1783e_f575_ccd4_36bd_5f0978c2172c
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  48523f49_1f0c_29c3_f64b_e37fdb914c83 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  6dd15b44_b15c_62ef_81b2_e72b28299be9["all.ts"]
  6dd15b44_b15c_62ef_81b2_e72b28299be9 --> 48523f49_1f0c_29c3_f64b_e37fdb914c83
  style 48523f49_1f0c_29c3_f64b_e37fdb914c83 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { ColumnBuilderBaseConfig, ColumnBuilderRuntimeConfig, MakeColumnConfig } from '~/column-builder.ts';
import type { ColumnBaseConfig } from '~/column.ts';
import { entityKind } from '~/entity.ts';
import type { AnyMySqlTable } from '~/mysql-core/table.ts';
import type { NonArray, Writable } from '~/utils.ts';
import { MySqlColumn, MySqlColumnBuilder } from './common.ts';

// enum as string union
export type MySqlEnumColumnBuilderInitial<TName extends string, TEnum extends string[]> = MySqlEnumColumnBuilder<{
	name: TName;
	dataType: 'string';
	columnType: 'MySqlEnumColumn';
	data: TEnum[number];
	driverParam: string;
	enumValues: TEnum;
}>;

export class MySqlEnumColumnBuilder<T extends ColumnBuilderBaseConfig<'string', 'MySqlEnumColumn'>>
	extends MySqlColumnBuilder<T, { enumValues: T['enumValues'] }>
{
	static override readonly [entityKind]: string = 'MySqlEnumColumnBuilder';

	constructor(name: T['name'], values: T['enumValues']) {
		super(name, 'string', 'MySqlEnumColumn');
		this.config.enumValues = values;
	}

	/** @internal */
	override build<TTableName extends string>(
		table: AnyMySqlTable<{ name: TTableName }>,
	): MySqlEnumColumn<MakeColumnConfig<T, TTableName> & { enumValues: T['enumValues'] }> {
		return new MySqlEnumColumn<MakeColumnConfig<T, TTableName> & { enumValues: T['enumValues'] }>(
			table,
			this.config as ColumnBuilderRuntimeConfig<any, any>,
		);
	}
}

export class MySqlEnumColumn<T extends ColumnBaseConfig<'string', 'MySqlEnumColumn'>>
	extends MySqlColumn<T, { enumValues: T['enumValues'] }>
{
	static override readonly [entityKind]: string = 'MySqlEnumColumn';

	override readonly enumValues = this.config.enumValues;

	getSQLType(): string {
		return `enum(${this.enumValues!.map((value) => `'${value}'`).join(',')})`;
	}
}

// enum as ts enum

export type MySqlEnumObjectColumnBuilderInitial<TName extends string, TEnum extends object> =
	MySqlEnumObjectColumnBuilder<{
		name: TName;
		dataType: 'string';
		columnType: 'MySqlEnumObjectColumn';
		data: TEnum[keyof TEnum];
		driverParam: string;
		enumValues: string[];
// ... (77 more lines)

Domain

Subdomains

Functions

Classes

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does enum.ts do?
enum.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, SQLDialects subdomain.
What functions are defined in enum.ts?
enum.ts defines 1 function(s): mysqlEnum.
What does enum.ts depend on?
enum.ts imports 7 module(s): MySqlColumn, column-builder.ts, column.ts, common.ts, entity.ts, table.ts, utils.ts.
What files import enum.ts?
enum.ts is imported by 1 file(s): all.ts.
Where is enum.ts in the architecture?
enum.ts is located at drizzle-orm/src/mysql-core/columns/enum.ts (domain: DrizzleORM, subdomain: SQLDialects, directory: drizzle-orm/src/mysql-core/columns).

Analyze Your Own Codebase

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

Try Supermodel Free