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
  d054debc_bee6_bef5_eef6_30cc2e19e981["mock()"]
  612dbe90_48c8_5f9e_1685_3ec048012649["driver.ts"]
  d054debc_bee6_bef5_eef6_30cc2e19e981 -->|defined in| 612dbe90_48c8_5f9e_1685_3ec048012649
  ff209639_b46d_95bc_ccdb_6ec0819cea71["construct()"]
  d054debc_bee6_bef5_eef6_30cc2e19e981 -->|calls| ff209639_b46d_95bc_ccdb_6ec0819cea71
  style d054debc_bee6_bef5_eef6_30cc2e19e981 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/gel/driver.ts lines 132–138

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