drizzle-orm Architecture Docs
Home / Function/ enum() — drizzle-orm Function Reference

enum() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers calls 2

Entity Profile

Dependency Diagram

graph TD
  249efdc8_1b0e_403f_43c4_4ca90662f215["enum()"]
  90f10471_a1b5_8de1_5619_3e25714527c7["PgSchema"]
  249efdc8_1b0e_403f_43c4_4ca90662f215 -->|defined in| 90f10471_a1b5_8de1_5619_3e25714527c7
  0d71fe46_fbca_d4ca_0aef_6d5eb079a5ac["pgEnumWithSchema()"]
  249efdc8_1b0e_403f_43c4_4ca90662f215 -->|calls| 0d71fe46_fbca_d4ca_0aef_6d5eb079a5ac
  a7ba3f30_6751_5b65_7507_a3cba6d0f585["pgEnumObjectWithSchema()"]
  249efdc8_1b0e_403f_43c4_4ca90662f215 -->|calls| a7ba3f30_6751_5b65_7507_a3cba6d0f585
  style 249efdc8_1b0e_403f_43c4_4ca90662f215 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/schema.ts lines 27–30

	public enum<U extends string, T extends Readonly<[U, ...U[]]>>(
		enumName: string,
		values: T | Writable<T>,
	): PgEnum<Writable<T>>;

Domain

Subdomains

Defined In

Calls

Source

Frequently Asked Questions

What does enum() do?
enum() is a function in the drizzle-orm codebase, defined in drizzle-orm/src/pg-core/schema.ts.
Where is enum() defined?
enum() is defined in drizzle-orm/src/pg-core/schema.ts at line 27.
What does enum() call?
enum() calls 2 function(s): pgEnumObjectWithSchema, pgEnumWithSchema.

Analyze Your Own Codebase

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

Try Supermodel Free