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
  16c0eb3d_a0c0_86bc_6bcd_f27883c8fe37["prepareQuery()"]
  f805b419_0d99_6c9e_b545_711ef568e8d9["TiDBServerlessSession"]
  16c0eb3d_a0c0_86bc_6bcd_f27883c8fe37 -->|defined in| f805b419_0d99_6c9e_b545_711ef568e8d9
  style 16c0eb3d_a0c0_86bc_6bcd_f27883c8fe37 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/tidb-serverless/session.ts lines 132–157

	prepareQuery<T extends MySqlPreparedQueryConfig = 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,
	): MySqlPreparedQuery<T> {
		return new TiDBServerlessPreparedQuery(
			this.client,
			query.sql,
			query.params,
			this.logger,
			this.cache,
			queryMetadata,
			cacheConfig,
			fields,
			customResultMapper,
			generatedIds,
			returningIds,
		);
	}