prepareQuery() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders

Entity Profile

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

Dependency Diagram

graph TD
  3a760d69_7fa5_43b3_9944_a0213d5c76ea["prepareQuery()"]
  d9dc85fd_6f6f_3c8c_1166_c2c099fbb874["NodePgSession"]
  3a760d69_7fa5_43b3_9944_a0213d5c76ea -->|defined in| d9dc85fd_6f6f_3c8c_1166_c2c099fbb874
  style 3a760d69_7fa5_43b3_9944_a0213d5c76ea fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/node-postgres/session.ts lines 221–246

	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 NodePgPreparedQuery(
			this.client,
			query.sql,
			query.params,
			this.logger,
			this.cache,
			queryMetadata,
			cacheConfig,
			fields,
			name,
			isResponseInArrayMode,
			customResultMapper,
		);
	}