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
  3dcfc0de_8503_779d_0e25_57ce38e75267["prepareQuery()"]
  82fb90e6_81ab_d654_1b28_6d304f059e88["SingleStoreDriverSession"]
  3dcfc0de_8503_779d_0e25_57ce38e75267 -->|defined in| 82fb90e6_81ab_d654_1b28_6d304f059e88
  style 3dcfc0de_8503_779d_0e25_57ce38e75267 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore/session.ts lines 222–249

	prepareQuery<T extends SingleStorePreparedQueryConfig>(
		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<SingleStoreDriverPreparedQueryHKT, T> {
		// Add returningId fields
		// Each driver gets them from response from database
		return new SingleStoreDriverPreparedQuery(
			this.client,
			query.sql,
			query.params,
			this.logger,
			this.cache,
			queryMetadata,
			cacheConfig,
			fields,
			customResultMapper,
			generatedIds,
			returningIds,
		) as PreparedQueryKind<SingleStoreDriverPreparedQueryHKT, T>;
	}