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
  c1cd7697_5f9d_2b96_9b42_20089b7ad841["drizzle()"]
  31b4414e_8263_88ee_640d_ad9fb5a46759["driver.ts"]
  c1cd7697_5f9d_2b96_9b42_20089b7ad841 -->|defined in| 31b4414e_8263_88ee_640d_ad9fb5a46759
  b91dc682_fc28_2e61_4197_8c9918cec2d7["construct()"]
  c1cd7697_5f9d_2b96_9b42_20089b7ad841 -->|calls| b91dc682_fc28_2e61_4197_8c9918cec2d7
  style c1cd7697_5f9d_2b96_9b42_20089b7ad841 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/libsql/driver.ts lines 7–50

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

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

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

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

		const instance = typeof connection === 'string' ? createClient({ url: connection }) : createClient(connection!);

		return construct(instance, drizzleConfig) as any;
	}

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