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
  412c0f72_ff84_8028_1616_d90ddd770c3f["mock()"]
  9bd9488e_a0fa_b4b6_7790_4361efcb51f2["driver.ts"]
  412c0f72_ff84_8028_1616_d90ddd770c3f -->|defined in| 9bd9488e_a0fa_b4b6_7790_4361efcb51f2
  b1cceb78_bbf5_9c3a_fc8b_674d4b3d47a6["construct()"]
  412c0f72_ff84_8028_1616_d90ddd770c3f -->|calls| b1cceb78_bbf5_9c3a_fc8b_674d4b3d47a6
  style 412c0f72_ff84_8028_1616_d90ddd770c3f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql2/driver.ts lines 176–182

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