pgEnumObjectWithSchema() — drizzle-orm Function Reference

Architecture documentation for the pgEnumObjectWithSchema() function in enum.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers called by 2

Entity Profile

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

Dependency Diagram

graph TD
  95f942c3_5071_5b7c_4981_1a774633963b["pgEnumObjectWithSchema()"]
  cc1fbfaa_1553_bc17_cd31_5fefac6896d3["enum.ts"]
  95f942c3_5071_5b7c_4981_1a774633963b -->|defined in| cc1fbfaa_1553_bc17_cd31_5fefac6896d3
  ef35cccb_f2ae_b05d_a159_b0dbd8b6a6f1["pgEnum()"]
  ef35cccb_f2ae_b05d_a159_b0dbd8b6a6f1 -->|calls| 95f942c3_5071_5b7c_4981_1a774633963b
  a5932bed_e5de_b594_d849_c3984cefac59["enum()"]
  a5932bed_e5de_b594_d849_c3984cefac59 -->|calls| 95f942c3_5071_5b7c_4981_1a774633963b
  style 95f942c3_5071_5b7c_4981_1a774633963b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/columns/enum.ts lines 184–201

export function pgEnumObjectWithSchema<T extends object>(
	enumName: string,
	values: T,
	schema?: string,
): PgEnumObject<T> {
	const enumInstance: PgEnumObject<T> = Object.assign(
		<TName extends string>(name?: TName): PgEnumObjectColumnBuilderInitial<TName, T> =>
			new PgEnumObjectColumnBuilder(name ?? '' as TName, enumInstance),
		{
			enumName,
			enumValues: Object.values(values),
			schema,
			[isPgEnumSym]: true,
		} as const,
	);

	return enumInstance;
}