pgEnum() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers calls 2

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/pg-core/columns/enum.ts lines 154–161

export function pgEnum(
	enumName: any,
	input: any,
): any {
	return Array.isArray(input)
		? pgEnumWithSchema(enumName, [...input] as [string, ...string[]], undefined)
		: pgEnumObjectWithSchema(enumName, input, undefined);
}