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
  1aae3bf8_af60_95c7_8856_8089f2f5905d["prepareQuery()"]
  3940e1dc_250a_3915_c2ab_7b508849bed6["GelDbSession"]
  1aae3bf8_af60_95c7_8856_8089f2f5905d -->|defined in| 3940e1dc_250a_3915_c2ab_7b508849bed6
  style 1aae3bf8_af60_95c7_8856_8089f2f5905d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/gel/session.ts lines 128–152

	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,
	): GelDbPreparedQuery<T> {
		return new GelDbPreparedQuery(
			this.client,
			query.sql,
			query.params,
			this.logger,
			this.cache,
			queryMetadata,
			cacheConfig,
			fields,
			isResponseInArrayMode,
			customResultMapper,
		);
	}