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

Entity Profile

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

Dependency Diagram

graph TD
  09eb6778_0039_9908_9821_3b19813da94d["drizzle()"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc["driver.ts"]
  09eb6778_0039_9908_9821_3b19813da94d -->|defined in| e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc
  811281dd_a2f3_96fc_b811_834647463172["construct()"]
  09eb6778_0039_9908_9821_3b19813da94d -->|calls| 811281dd_a2f3_96fc_b811_834647463172
  style 09eb6778_0039_9908_9821_3b19813da94d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore/driver.ts lines 123–184

export function drizzle<
	TSchema extends Record<string, unknown> = Record<string, never>,
	TClient extends AnySingleStoreDriverConnection = CallbackPool,
>(
	...params: [
		TClient | string,
	] | [
		TClient | string,
		SingleStoreDriverDrizzleConfig<TSchema>,
	] | [
		(
			& SingleStoreDriverDrizzleConfig<TSchema>
			& ({
				connection: string | PoolOptions;
			} | {
				client: TClient;
			})
		),
	]
): SingleStoreDriverDatabase<TSchema> & {
	$client: AnySingleStoreDriverConnection extends TClient ? CallbackPool : TClient;
} {
	if (typeof params[0] === 'string') {
		const connectionString = params[0]!;
		const instance = createPool({
			uri: connectionString,
			connectAttributes: CONNECTION_ATTRS,
		});

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

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

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

		let opts: PoolOptions = {};
		opts = typeof connection === 'string'
			? {
				uri: connection,
				supportBigNumbers: true,
				connectAttributes: CONNECTION_ATTRS,
			}
			: {
				...connection,
				connectAttributes: {
					...connection!.connectAttributes,
					...CONNECTION_ATTRS,
				},
			};

		const instance = createPool(opts);
		const db = construct(instance, drizzleConfig);

		return db as any;
	}

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