prepareQuery() — drizzle-orm Function Reference

Architecture documentation for the prepareQuery() function in session.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

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

Dependency Diagram

graph TD
  58bf0ee3_1314_96da_0ba3_51a7254110e2["prepareQuery()"]
  60b52bae_f4fa_9a37_62a0_75cca0daeace["PgRemoteSession"]
  58bf0ee3_1314_96da_0ba3_51a7254110e2 -->|defined in| 60b52bae_f4fa_9a37_62a0_75cca0daeace
  style 58bf0ee3_1314_96da_0ba3_51a7254110e2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-proxy/session.ts lines 43–68

	prepareQuery<T extends PreparedQueryConfig>(
		query: QueryWithTypings,
		fields: SelectedFieldsOrdered | undefined,
		name: string | undefined,
		isResponseInArrayMode: boolean,
		customResultMapper?: (rows: unknown[][]) => T['execute'],
		queryMetadata?: {
			type: 'select' | 'update' | 'delete' | 'insert';
			tables: string[];
		},
		cacheConfig?: WithCacheConfig,
	): PreparedQuery<T> {
		return new PreparedQuery(
			this.client,
			query.sql,
			query.params,
			query.typings,
			this.logger,
			this.cache,
			queryMetadata,
			cacheConfig,
			fields,
			isResponseInArrayMode,
			customResultMapper,
		);
	}