singlestoreEnum() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders

Entity Profile

DrizzleORM→ QueryBuilders→ singlestoreEnum() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  a970f4a0_aa93_50fa_ddd8_5fa3cb90203b["singlestoreEnum()"]
  07867c35_1c2d_5b08_ba76_fc5a76bb421b["enum.ts"]
  a970f4a0_aa93_50fa_ddd8_5fa3cb90203b -->|defined in| 07867c35_1c2d_5b08_ba76_fc5a76bb421b
  style a970f4a0_aa93_50fa_ddd8_5fa3cb90203b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore-core/columns/enum.ts lines 73–84

export function singlestoreEnum(
	a?: string | readonly [string, ...string[]] | [string, ...string[]],
	b?: readonly [string, ...string[]] | [string, ...string[]],
): any {
	const { name, config: values } = getColumnNameAndConfig<readonly [string, ...string[]] | [string, ...string[]]>(a, b);

	if (values.length === 0) {
		throw new Error(`You have an empty array for "${name}" enum values`);
	}

	return new SingleStoreEnumColumnBuilder(name, values as any);
}