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
  ac27bdfc_e137_7ff1_d462_d21fb47cff63["drizzle()"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda["driver.ts"]
  ac27bdfc_e137_7ff1_d462_d21fb47cff63 -->|defined in| 0f0ec9c4_1c93_fe87_a305_092d4756cbda
  42e7d306_17c9_7169_e16c_0f1e46bd2fb2["construct()"]
  ac27bdfc_e137_7ff1_d462_d21fb47cff63 -->|calls| 42e7d306_17c9_7169_e16c_0f1e46bd2fb2
  style ac27bdfc_e137_7ff1_d462_d21fb47cff63 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/postgres-js/driver.ts lines 70–118

export function drizzle<
	TSchema extends Record<string, unknown> = Record<string, never>,
	TClient extends Sql = Sql,
>(
	...params: [
		TClient | string,
	] | [
		TClient | string,
		DrizzleConfig<TSchema>,
	] | [
		(
			& DrizzleConfig<TSchema>
			& ({
				connection: string | ({ url?: string } & Options<Record<string, PostgresType>>);
			} | {
				client: TClient;
			})
		),
	]
): PostgresJsDatabase<TSchema> & {
	$client: TClient;
} {
	if (typeof params[0] === 'string') {
		const instance = pgClient(params[0] as string);

		return construct(instance, params[1]) as any;
	}

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

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

		if (typeof connection === 'object' && connection.url !== undefined) {
			const { url, ...config } = connection;

			const instance = pgClient(url, config);
			return construct(instance, drizzleConfig) as any;
		}

		const instance = pgClient(connection);
		return construct(instance, drizzleConfig) as any;
	}

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