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
  18e21a91_59b5_5977_63c4_100d0e7edd99["prepareQuery()"]
  72c91484_cab6_d439_500e_f049505aadf3["PostgresJsSession"]
  18e21a91_59b5_5977_63c4_100d0e7edd99 -->|defined in| 72c91484_cab6_d439_500e_f049505aadf3
  style 18e21a91_59b5_5977_63c4_100d0e7edd99 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/postgres-js/session.ts lines 129–153

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