mock() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers calls 1

Entity Profile

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

Dependency Diagram

graph TD
  7d4356ad_647c_27e8_a776_8e9b9e7cc890["mock()"]
  d4882ed1_0e96_6210_f61b_425eb48edf20["driver.ts"]
  7d4356ad_647c_27e8_a776_8e9b9e7cc890 -->|defined in| d4882ed1_0e96_6210_f61b_425eb48edf20
  2c9f0c0b_5d77_79ee_96f7_a24bf445c5c0["construct()"]
  7d4356ad_647c_27e8_a776_8e9b9e7cc890 -->|calls| 2c9f0c0b_5d77_79ee_96f7_a24bf445c5c0
  style 7d4356ad_647c_27e8_a776_8e9b9e7cc890 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/aws-data-api/pg/driver.ts lines 182–188

	export function mock<TSchema extends Record<string, unknown> = Record<string, never>>(
		config: DrizzleAwsDataApiPgConfig<TSchema>,
	): AwsDataApiPgDatabase<TSchema> & {
		$client: '$client is not available on drizzle.mock()';
	} {
		return construct({} as any, config) as any;
	}