execute() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery called by 2

Entity Profile

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

Dependency Diagram

graph TD
  0d0d9914_7bbd_c75e_f74a_0d3e57b68553["execute()"]
  3e5fd3be_708b_5a31_d952_06f96db1eba7["TiDBServerlessPreparedQuery"]
  0d0d9914_7bbd_c75e_f74a_0d3e57b68553 -->|defined in| 3e5fd3be_708b_5a31_d952_06f96db1eba7
  48f691ad_fa81_e448_0c04_e58df255ff70["all()"]
  48f691ad_fa81_e448_0c04_e58df255ff70 -->|calls| 0d0d9914_7bbd_c75e_f74a_0d3e57b68553
  3c5541de_40e9_f9b6_c940_ea976fc1b1b9["transaction()"]
  3c5541de_40e9_f9b6_c940_ea976fc1b1b9 -->|calls| 0d0d9914_7bbd_c75e_f74a_0d3e57b68553
  style 0d0d9914_7bbd_c75e_f74a_0d3e57b68553 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/tidb-serverless/session.ts lines 50–97

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

		this.logger.logQuery(this.queryString, params);

		const { fields, client, queryString, joinsNotNullableMap, customResultMapper, returningIds, generatedIds } = this;
		if (!fields && !customResultMapper) {
			const res = await this.queryWithCache(queryString, params, async () => {
				return await client.execute(queryString, params, executeRawConfig) as FullResult;
			});
			const insertId = res.lastInsertId ?? 0;
			const affectedRows = res.rowsAffected ?? 0;
			// for each row, I need to check keys from
			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 res;
		}

		const rows = await this.queryWithCache(queryString, params, async () => {
			return await client.execute(queryString, params, queryConfig) as unknown[][];
		});

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

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