pgEnumWithSchema() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers called by 2

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/pg-core/columns/enum.ts lines 164–181

export function pgEnumWithSchema<U extends string, T extends Readonly<[U, ...U[]]>>(
	enumName: string,
	values: T | Writable<T>,
	schema?: string,
): PgEnum<Writable<T>> {
	const enumInstance: PgEnum<Writable<T>> = Object.assign(
		<TName extends string>(name?: TName): PgEnumColumnBuilderInitial<TName, Writable<T>> =>
			new PgEnumColumnBuilder(name ?? '' as TName, enumInstance),
		{
			enumName,
			enumValues: values,
			schema,
			[isPgEnumSym]: true,
		} as const,
	);

	return enumInstance;
}