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
  407a06a3_991d_fd9d_28f0_419416feb0f0["prepareQuery()"]
  5a015744_9261_7efe_f6db_2bc9413b3057["MySql2Session"]
  407a06a3_991d_fd9d_28f0_419416feb0f0 -->|defined in| 5a015744_9261_7efe_f6db_2bc9413b3057
  style 407a06a3_991d_fd9d_28f0_419416feb0f0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql2/session.ts lines 226–253

	prepareQuery<T extends MySqlPreparedQueryConfig>(
		query: Query,
		fields: SelectedFieldsOrdered | undefined,
		customResultMapper?: (rows: unknown[][]) => T['execute'],
		generatedIds?: Record<string, unknown>[],
		returningIds?: SelectedFieldsOrdered,
		queryMetadata?: {
			type: 'select' | 'update' | 'delete' | 'insert';
			tables: string[];
		},
		cacheConfig?: WithCacheConfig,
	): PreparedQueryKind<MySql2PreparedQueryHKT, T> {
		// Add returningId fields
		// Each driver gets them from response from database
		return new MySql2PreparedQuery(
			this.client,
			query.sql,
			query.params,
			this.logger,
			this.cache,
			queryMetadata,
			cacheConfig,
			fields,
			customResultMapper,
			generatedIds,
			returningIds,
		) as PreparedQueryKind<MySql2PreparedQueryHKT, T>;
	}