drizzle() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders calls 1

Entity Profile

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

Dependency Diagram

graph TD
  e09c9fbe_d3d3_f26e_ac98_045d8721ece5["drizzle()"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8["driver.ts"]
  e09c9fbe_d3d3_f26e_ac98_045d8721ece5 -->|defined in| 4900d433_b74f_ced2_6f6d_410f252d1ff8
  1979ab42_37b3_68cb_c787_e9fd797c7e1f["construct()"]
  e09c9fbe_d3d3_f26e_ac98_045d8721ece5 -->|calls| 1979ab42_37b3_68cb_c787_e9fd797c7e1f
  style e09c9fbe_d3d3_f26e_ac98_045d8721ece5 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/vercel-postgres/driver.ts lines 87–113

export function drizzle<
	TSchema extends Record<string, unknown> = Record<string, never>,
	TClient extends VercelPgClient = typeof sql,
>(
	...params: [] | [
		TClient,
	] | [
		TClient,
		DrizzleConfig<TSchema>,
	] | [
		(
			& DrizzleConfig<TSchema>
			& ({
				client?: TClient;
			})
		),
	]
): VercelPgDatabase<TSchema> & {
	$client: VercelPgClient extends TClient ? typeof sql : TClient;
} {
	if (isConfig(params[0])) {
		const { client, ...drizzleConfig } = params[0] as ({ client?: TClient } & DrizzleConfig<TSchema>);
		return construct(client ?? sql, drizzleConfig) as any;
	}

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