drizzle() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 1

Entity Profile

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

Dependency Diagram

graph TD
  780a45cc_231e_c73e_4099_81954c63cedc["drizzle()"]
  053b47f2_f302_5369_9ab2_7667cbadf49f["driver.ts"]
  780a45cc_231e_c73e_4099_81954c63cedc -->|defined in| 053b47f2_f302_5369_9ab2_7667cbadf49f
  368e6c67_d9ba_9a79_058d_3e77198ecbf9["construct()"]
  780a45cc_231e_c73e_4099_81954c63cedc -->|calls| 368e6c67_d9ba_9a79_058d_3e77198ecbf9
  style 780a45cc_231e_c73e_4099_81954c63cedc fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/bun-sql/driver.ts lines 63–111

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

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

	if (isConfig(params[0])) {
		const { connection, client, ...drizzleConfig } = params[0] as {
			connection?: { url?: string } & SQLOptions;
			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 = new SQL({ url, ...config });
			return construct(instance, drizzleConfig) as any;
		}

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

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