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

Relationship Graph

Source Code

drizzle-orm/src/tidb-serverless/driver.ts lines 66–111

export function drizzle<
	TSchema extends Record<string, unknown> = Record<string, never>,
	TClient extends Connection = Connection,
>(
	...params: [
		TClient | string,
	] | [
		TClient | string,
		DrizzleConfig<TSchema>,
	] | [
		& ({
			connection: string | Config;
		} | {
			client: TClient;
		})
		& DrizzleConfig<TSchema>,
	]
): TiDBServerlessDatabase<TSchema> & {
	$client: TClient;
} {
	if (typeof params[0] === 'string') {
		const instance = connect({
			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<TSchema>;

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

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

		return construct(instance, drizzleConfig) as any;
	}

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