Home / Class/ PreparedQuery Class — drizzle-orm Architecture

PreparedQuery Class — drizzle-orm Architecture

Architecture documentation for the PreparedQuery class in session.ts from the drizzle-orm codebase.

Entity Profile

Dependency Diagram

graph TD
  ab3cb454_82e9_2f1c_b29d_f8d94ea06ccc["PreparedQuery"]
  06097e19_bcad_7d24_ee80_bf451d27455d["session.ts"]
  ab3cb454_82e9_2f1c_b29d_f8d94ea06ccc -->|defined in| 06097e19_bcad_7d24_ee80_bf451d27455d
  a8f38194_c681_a41c_7683_ebe766f2ab05["constructor()"]
  ab3cb454_82e9_2f1c_b29d_f8d94ea06ccc -->|method| a8f38194_c681_a41c_7683_ebe766f2ab05
  4325232a_a065_1cbe_cdb1_1b0efb0ddfda["execute()"]
  ab3cb454_82e9_2f1c_b29d_f8d94ea06ccc -->|method| 4325232a_a065_1cbe_cdb1_1b0efb0ddfda
  8955f52e_4ecf_4f67_1ac0_396168ab5acf["iterator()"]
  ab3cb454_82e9_2f1c_b29d_f8d94ea06ccc -->|method| 8955f52e_4ecf_4f67_1ac0_396168ab5acf

Relationship Graph

Source Code

drizzle-orm/src/mysql-proxy/session.ts lines 106–188

export class PreparedQuery<T extends MySqlPreparedQueryConfig> extends PreparedQueryBase<T> {
	static override readonly [entityKind]: string = 'MySqlProxyPreparedQuery';

	constructor(
		private client: RemoteCallback,
		private queryString: string,
		private params: unknown[],
		private logger: Logger,
		cache: Cache,
		queryMetadata: {
			type: 'select' | 'update' | 'delete' | 'insert';
			tables: string[];
		} | undefined,
		cacheConfig: WithCacheConfig | undefined,
		private fields: SelectedFieldsOrdered | undefined,
		private customResultMapper?: (rows: unknown[][]) => T['execute'],
		// Keys that were used in $default and the value that was generated for them
		private generatedIds?: Record<string, unknown>[],
		// Keys that should be returned, it has the column with all properries + key from object
		private returningIds?: SelectedFieldsOrdered,
	) {
		super(cache, queryMetadata, cacheConfig);
	}

	async execute(placeholderValues: Record<string, unknown> | undefined = {}): Promise<T['execute']> {
		const params = fillPlaceholders(this.params, placeholderValues);

		const { fields, client, queryString, logger, joinsNotNullableMap, customResultMapper, returningIds, generatedIds } =
			this;

		logger.logQuery(queryString, params);

		if (!fields && !customResultMapper) {
			const { rows: data } = await this.queryWithCache(queryString, params, async () => {
				return await client(queryString, params, 'execute');
			});

			const insertId = data[0].insertId as number;
			const affectedRows = data[0].affectedRows;

			if (returningIds) {
				const returningResponse = [];
				let j = 0;
				for (let i = insertId; i < insertId + affectedRows; i++) {
					for (const column of returningIds) {
						const key = returningIds[0]!.path[0]!;
						if (is(column.field, Column)) {
							// @ts-ignore
							if (column.field.primary && column.field.autoIncrement) {
								returningResponse.push({ [key]: i });
							}
							if (column.field.defaultFn && generatedIds) {
								// generatedIds[rowIdx][key]
								returningResponse.push({ [key]: generatedIds[j]![key] });
							}
						}
					}
					j++;
				}

				return returningResponse;
			}

			return data;
		}

		const { rows } = await this.queryWithCache(queryString, params, async () => {
			return await client(queryString, params, 'all');
		});

		if (customResultMapper) {
			return customResultMapper(rows);
		}

		return rows.map((row) => mapResultRow<T['execute']>(fields!, row, joinsNotNullableMap));
	}

	override iterator(
		_placeholderValues: Record<string, unknown> = {},
	): AsyncGenerator<T['iterator']> {
		throw new Error('Streaming is not supported by the MySql Proxy driver');

Domain

Frequently Asked Questions

What is the PreparedQuery class?
PreparedQuery is a class in the drizzle-orm codebase, defined in drizzle-orm/src/mysql-proxy/session.ts.
Where is PreparedQuery defined?
PreparedQuery is defined in drizzle-orm/src/mysql-proxy/session.ts at line 106.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free