drizzle() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers calls 1 called by 1

Entity Profile

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

Dependency Diagram

graph TD
  ce7be1b5_4965_6e99_7398_e412931d3cab["drizzle()"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd["driver.ts"]
  ce7be1b5_4965_6e99_7398_e412931d3cab -->|defined in| b80e0b43_b72d_90f7_a9b9_73f6d40500bd
  3ba40f9b_b633_3516_3344_288f45fb5891["construct()"]
  3ba40f9b_b633_3516_3344_288f45fb5891 -->|calls| ce7be1b5_4965_6e99_7398_e412931d3cab
  3ba40f9b_b633_3516_3344_288f45fb5891["construct()"]
  ce7be1b5_4965_6e99_7398_e412931d3cab -->|calls| 3ba40f9b_b633_3516_3344_288f45fb5891
  style ce7be1b5_4965_6e99_7398_e412931d3cab fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/planetscale-serverless/driver.ts lines 87–136

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;
			})
		),
	]
): PlanetScaleDatabase<TSchema> & {
	$client: TClient;
} {
	if (typeof params[0] === 'string') {
		const instance = new Client({
			url: params[0],
		});

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

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

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

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

		return construct(instance, drizzleConfig) as any;
	}

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