batch() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders calls 3 called by 1

Entity Profile

DrizzleORM→ QueryBuilders→ batch() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  c7e65865_976b_3541_a589_439b5bed44ab["batch()"]
  b5f39cbd_0992_c93c_e18e_1884481a37ac["NeonHttpSession"]
  c7e65865_976b_3541_a589_439b5bed44ab -->|defined in| b5f39cbd_0992_c93c_e18e_1884481a37ac
  5368b08b_74cf_5701_e75a_ed797652c063["batch()"]
  5368b08b_74cf_5701_e75a_ed797652c063 -->|calls| c7e65865_976b_3541_a589_439b5bed44ab
  c01da418_beda_3a56_5f2e_96919c4a7288["isResponseInArrayMode()"]
  c7e65865_976b_3541_a589_439b5bed44ab -->|calls| c01da418_beda_3a56_5f2e_96919c4a7288
  71e0e369_bc60_d29d_69a1_514039e4dc82["mapResult()"]
  c7e65865_976b_3541_a589_439b5bed44ab -->|calls| 71e0e369_bc60_d29d_69a1_514039e4dc82
  52c1ef7d_81ad_6f3b_1b54_31d8fade3656["transaction()"]
  c7e65865_976b_3541_a589_439b5bed44ab -->|calls| 52c1ef7d_81ad_6f3b_1b54_31d8fade3656
  style c7e65865_976b_3541_a589_439b5bed44ab fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/neon-http/session.ts lines 199–219

	async batch<U extends BatchItem<'pg'>, T extends Readonly<[U, ...U[]]>>(
		queries: T,
	) {
		const preparedQueries: PreparedQuery[] = [];
		const builtQueries: NeonQueryPromise<any, true>[] = [];
		for (const query of queries) {
			const preparedQuery = query._prepare();
			const builtQuery = preparedQuery.getQuery();
			preparedQueries.push(preparedQuery);
			builtQueries.push(
				this.clientQuery(builtQuery.sql, builtQuery.params, {
					fullResults: true,
					arrayMode: preparedQuery.isResponseInArrayMode(),
				}),
			);
		}

		const batchResults = await this.client.transaction(builtQueries, queryConfig);

		return batchResults.map((result, i) => preparedQueries[i]!.mapResult(result, true)) as any;
	}