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 DatabaseDrivers 7 imports 1 dependents 4 functions 4 classes

Entity Profile

Dependency Diagram

graph LR
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3["enum.ts"]
  f4f42b4c_8610_03dd_fe01_232098668127["common.ts"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3 --> f4f42b4c_8610_03dd_fe01_232098668127
  099d7c6d_2fc4_7b20_40e3_1b8af4138fe6["PgColumn"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3 --> 099d7c6d_2fc4_7b20_40e3_1b8af4138fe6
  2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3 --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426
  05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3 --> 05f0a280_d0c9_693a_a4bf_83cc671012d2
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  17418917_ff81_c4e5_90f4_f37d557e5d51["table.ts"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3 --> 17418917_ff81_c4e5_90f4_f37d557e5d51
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  06e0abfd_8dae_0f31_4535_349e0a684907["schema.ts"]
  06e0abfd_8dae_0f31_4535_349e0a684907 --> cc1fbfaa_1553_bc17_cd31_5fefac6896d3
  style cc1fbfaa_1553_bc17_cd31_5fefac6896d3 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 { AnyPgTable } from '~/pg-core/table.ts';
import type { NonArray, Writable } from '~/utils.ts';
import { PgColumn, PgColumnBuilder } from './common.ts';

// Enum as ts enum

export type PgEnumObjectColumnBuilderInitial<TName extends string, TValues extends object> = PgEnumObjectColumnBuilder<{
	name: TName;
	dataType: 'string';
	columnType: 'PgEnumObjectColumn';
	data: TValues[keyof TValues];
	enumValues: string[];
	driverParam: string;
}>;

export interface PgEnumObject<TValues extends object> {
	(): PgEnumObjectColumnBuilderInitial<'', TValues>;
	<TName extends string>(name: TName): PgEnumObjectColumnBuilderInitial<TName, TValues>;
	<TName extends string>(name?: TName): PgEnumObjectColumnBuilderInitial<TName, TValues>;

	readonly enumName: string;
	readonly enumValues: string[];
	readonly schema: string | undefined;
	/** @internal */
	[isPgEnumSym]: true;
}

export class PgEnumObjectColumnBuilder<
	T extends ColumnBuilderBaseConfig<'string', 'PgEnumObjectColumn'> & { enumValues: string[] },
> extends PgColumnBuilder<T, { enum: PgEnumObject<any> }> {
	static override readonly [entityKind]: string = 'PgEnumObjectColumnBuilder';

	constructor(name: T['name'], enumInstance: PgEnumObject<any>) {
		super(name, 'string', 'PgEnumObjectColumn');
		this.config.enum = enumInstance;
	}

	/** @internal */
	override build<TTableName extends string>(
		table: AnyPgTable<{ name: TTableName }>,
	): PgEnumObjectColumn<MakeColumnConfig<T, TTableName>> {
		return new PgEnumObjectColumn<MakeColumnConfig<T, TTableName>>(
			table,
			this.config as ColumnBuilderRuntimeConfig<any, any>,
		);
	}
}

export class PgEnumObjectColumn<T extends ColumnBaseConfig<'string', 'PgEnumObjectColumn'> & { enumValues: object }>
	extends PgColumn<T, { enum: PgEnumObject<object> }>
{
	static override readonly [entityKind]: string = 'PgEnumObjectColumn';

	readonly enum;
	override readonly enumValues = this.config.enum.enumValues;

	constructor(
// ... (142 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, DatabaseDrivers subdomain.
What functions are defined in enum.ts?
enum.ts defines 4 function(s): isPgEnum, pgEnum, pgEnumObjectWithSchema, pgEnumWithSchema.
What does enum.ts depend on?
enum.ts imports 7 module(s): PgColumn, 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): schema.ts.
Where is enum.ts in the architecture?
enum.ts is located at drizzle-orm/src/pg-core/columns/enum.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/pg-core/columns).

Analyze Your Own Codebase

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

Try Supermodel Free