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
  34204185_d2a0_e4b6_9f5a_d4fcdf89b9b1["drizzle()"]
  d4882ed1_0e96_6210_f61b_425eb48edf20["driver.ts"]
  34204185_d2a0_e4b6_9f5a_d4fcdf89b9b1 -->|defined in| d4882ed1_0e96_6210_f61b_425eb48edf20
  2c9f0c0b_5d77_79ee_96f7_a24bf445c5c0["construct()"]
  34204185_d2a0_e4b6_9f5a_d4fcdf89b9b1 -->|calls| 2c9f0c0b_5d77_79ee_96f7_a24bf445c5c0
  style 34204185_d2a0_e4b6_9f5a_d4fcdf89b9b1 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/aws-data-api/pg/driver.ts lines 133–179

export function drizzle<
	TSchema extends Record<string, unknown> = Record<string, never>,
	TClient extends AwsDataApiClient = RDSDataClient,
>(
	...params: [
		TClient,
		DrizzleAwsDataApiPgConfig<TSchema>,
	] | [
		(
			| (
				& DrizzleConfig<TSchema>
				& {
					connection: RDSDataClientConfig & Omit<DrizzleAwsDataApiPgConfig, keyof DrizzleConfig>;
				}
			)
			| (
				& DrizzleAwsDataApiPgConfig<TSchema>
				& {
					client: TClient;
				}
			)
		),
	]
): AwsDataApiPgDatabase<TSchema> & {
	$client: TClient;
} {
	// eslint-disable-next-line no-instanceof/no-instanceof
	if (params[0] instanceof RDSDataClient || params[0].constructor.name !== 'Object') {
		return construct(params[0] as TClient, params[1] as DrizzleAwsDataApiPgConfig<TSchema>) as any;
	}

	if ((params[0] as { client?: TClient }).client) {
		const { client, ...drizzleConfig } = params[0] as {
			client: TClient;
		} & DrizzleAwsDataApiPgConfig<TSchema>;

		return construct(client, drizzleConfig) as any;
	}

	const { connection, ...drizzleConfig } = params[0] as {
		connection: RDSDataClientConfig & Omit<DrizzleAwsDataApiPgConfig, keyof DrizzleConfig>;
	} & DrizzleConfig<TSchema>;
	const { resourceArn, database, secretArn, ...rdsConfig } = connection;

	const instance = new RDSDataClient(rdsConfig);
	return construct(instance, { resourceArn, database, secretArn, ...drizzleConfig }) as any;
}