mock() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery calls 1

Entity Profile

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

Dependency Diagram

graph TD
  9509f40e_bed6_5462_f373_2a7d1ed01e60["mock()"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca["driver.ts"]
  9509f40e_bed6_5462_f373_2a7d1ed01e60 -->|defined in| 3ae74e9d_9ef5_2553_ca81_fae936d635ca
  b434e2e8_087d_9e43_af9c_ade269dae37f["construct()"]
  9509f40e_bed6_5462_f373_2a7d1ed01e60 -->|calls| b434e2e8_087d_9e43_af9c_ade269dae37f
  style 9509f40e_bed6_5462_f373_2a7d1ed01e60 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/tidb-serverless/driver.ts lines 114–120

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