prepareQuery() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

graph TD
  0302252e_7659_85c3_30b2_3f035c1fcd5a["prepareQuery()"]
  9b87d13f_b108_a6bb_f37d_c1cb86125580["MySqlRemoteSession"]
  0302252e_7659_85c3_30b2_3f035c1fcd5a -->|defined in| 9b87d13f_b108_a6bb_f37d_c1cb86125580
  style 0302252e_7659_85c3_30b2_3f035c1fcd5a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-proxy/session.ts lines 52–77

	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<MySqlRemotePreparedQueryHKT, T> {
		return new PreparedQuery(
			this.client,
			query.sql,
			query.params,
			this.logger,
			this.cache,
			queryMetadata,
			cacheConfig,
			fields,
			customResultMapper,
			generatedIds,
			returningIds,
		) as PreparedQueryKind<MySqlRemotePreparedQueryHKT, T>;
	}