transaction() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery calls 2 called by 1

Entity Profile

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

Dependency Diagram

graph TD
  b8fec522_2a54_80d3_4ec6_c807a719fed2["transaction()"]
  53b78ffc_ad9b_9400_ddd7_0a343a1144bf["PlanetScaleTransaction"]
  b8fec522_2a54_80d3_4ec6_c807a719fed2 -->|defined in| 53b78ffc_ad9b_9400_ddd7_0a343a1144bf
  f84fa8d7_0dce_6066_1b3c_5328a5e3a71f["transaction()"]
  f84fa8d7_0dce_6066_1b3c_5328a5e3a71f -->|calls| b8fec522_2a54_80d3_4ec6_c807a719fed2
  73cab381_871d_ad4b_62e2_b6784fb4fbec["execute()"]
  b8fec522_2a54_80d3_4ec6_c807a719fed2 -->|calls| 73cab381_871d_ad4b_62e2_b6784fb4fbec
  f84fa8d7_0dce_6066_1b3c_5328a5e3a71f["transaction()"]
  b8fec522_2a54_80d3_4ec6_c807a719fed2 -->|calls| f84fa8d7_0dce_6066_1b3c_5328a5e3a71f
  style b8fec522_2a54_80d3_4ec6_c807a719fed2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/planetscale-serverless/session.ts lines 228–247

	override async transaction<T>(
		transaction: (tx: PlanetScaleTransaction<TFullSchema, TSchema>) => Promise<T>,
	): Promise<T> {
		const savepointName = `sp${this.nestedIndex + 1}`;
		const tx = new PlanetScaleTransaction<TFullSchema, TSchema>(
			this.dialect,
			this.session,
			this.schema,
			this.nestedIndex + 1,
		);
		await tx.execute(sql.raw(`savepoint ${savepointName}`));
		try {
			const result = await transaction(tx);
			await tx.execute(sql.raw(`release savepoint ${savepointName}`));
			return result;
		} catch (err) {
			await tx.execute(sql.raw(`rollback to savepoint ${savepointName}`));
			throw err;
		}
	}