drizzle() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery calls 1

Entity Profile

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

Dependency Diagram

graph TD
  375b0bf0_2dc3_e4f1_61d7_3c127f88f970["drizzle()"]
  612dbe90_48c8_5f9e_1685_3ec048012649["driver.ts"]
  375b0bf0_2dc3_e4f1_61d7_3c127f88f970 -->|defined in| 612dbe90_48c8_5f9e_1685_3ec048012649
  ff209639_b46d_95bc_ccdb_6ec0819cea71["construct()"]
  375b0bf0_2dc3_e4f1_61d7_3c127f88f970 -->|calls| ff209639_b46d_95bc_ccdb_6ec0819cea71
  style 375b0bf0_2dc3_e4f1_61d7_3c127f88f970 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/gel/driver.ts lines 88–129

export function drizzle<
	TSchema extends Record<string, unknown> = Record<string, never>,
	TClient extends GelClient = Client,
>(
	...params:
		| [TClient | string]
		| [TClient | string, DrizzleConfig<TSchema>]
		| [
			& DrizzleConfig<TSchema>
			& (
				| {
					connection: string | ConnectOptions;
				}
				| {
					client: TClient;
				}
			),
		]
): GelJsDatabase<TSchema> & {
	$client: GelClient extends TClient ? Client : TClient;
} {
	if (typeof params[0] === 'string') {
		const instance = createClient({ dsn: params[0] });

		return construct(instance, params[1] as DrizzleConfig<TSchema> | undefined) as any;
	}

	if (isConfig(params[0])) {
		const { connection, client, ...drizzleConfig } = params[0] as (
			& ({ connection?: ConnectOptions | string; client?: TClient })
			& DrizzleConfig<TSchema>
		);

		if (client) return construct(client, drizzleConfig);

		const instance = createClient(connection);

		return construct(instance, drizzleConfig) as any;
	}

	return construct(params[0] as TClient, params[1] as DrizzleConfig<TSchema> | undefined) as any;
}