drizzle() — drizzle-orm Function Reference

Architecture documentation for the drizzle() function in index.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
  16e97695_579c_1ca2_4393_47d4030c9b56["drizzle()"]
  6bfdce1e_706e_579b_832f_32adb5a37a49["index.ts"]
  16e97695_579c_1ca2_4393_47d4030c9b56 -->|defined in| 6bfdce1e_706e_579b_832f_32adb5a37a49
  b91dc682_fc28_2e61_4197_8c9918cec2d7["construct()"]
  16e97695_579c_1ca2_4393_47d4030c9b56 -->|calls| b91dc682_fc28_2e61_4197_8c9918cec2d7
  style 16e97695_579c_1ca2_4393_47d4030c9b56 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/libsql/sqlite3/index.ts lines 5–48

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;
}