gelSchema() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery

Entity Profile

DrizzleORM→ RelationalQuery→ gelSchema() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  45d36cc2_3921_b60c_f651_5959a26055ed["gelSchema()"]
  a24fdf3c_9905_a1c9_be31_c88bf0a5c079["schema.ts"]
  45d36cc2_3921_b60c_f651_5959a26055ed -->|defined in| a24fdf3c_9905_a1c9_be31_c88bf0a5c079
  style 45d36cc2_3921_b60c_f651_5959a26055ed fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/gel-core/schema.ts lines 48–56

export function gelSchema<T extends string>(name: T) {
	if (name === 'public') {
		throw new Error(
			`You can't specify 'public' as schema name. Postgres is using public schema by default. If you want to use 'public' schema, just use GelTable() instead of creating a schema`,
		);
	}

	return new GelSchema(name);
}