execute() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

graph TD
  4325232a_a065_1cbe_cdb1_1b0efb0ddfda["execute()"]
  ab3cb454_82e9_2f1c_b29d_f8d94ea06ccc["PreparedQuery"]
  4325232a_a065_1cbe_cdb1_1b0efb0ddfda -->|defined in| ab3cb454_82e9_2f1c_b29d_f8d94ea06ccc
  style 4325232a_a065_1cbe_cdb1_1b0efb0ddfda fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-proxy/session.ts lines 130–181

	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));
	}