transaction() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers calls 2 called by 1

Entity Profile

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

Dependency Diagram

graph TD
  281944dd_c9ab_27a8_fd24_20b3c5b86a80["transaction()"]
  021be121_52f7_a344_035f_56374d0dd9ef["MySql2Transaction"]
  281944dd_c9ab_27a8_fd24_20b3c5b86a80 -->|defined in| 021be121_52f7_a344_035f_56374d0dd9ef
  b7d6681b_98af_3cb1_ca29_b651e8016689["transaction()"]
  b7d6681b_98af_3cb1_ca29_b651e8016689 -->|calls| 281944dd_c9ab_27a8_fd24_20b3c5b86a80
  27c4ec08_2b89_4cd2_2eb6_775ccd3cb0d8["execute()"]
  281944dd_c9ab_27a8_fd24_20b3c5b86a80 -->|calls| 27c4ec08_2b89_4cd2_2eb6_775ccd3cb0d8
  b7d6681b_98af_3cb1_ca29_b651e8016689["transaction()"]
  281944dd_c9ab_27a8_fd24_20b3c5b86a80 -->|calls| b7d6681b_98af_3cb1_ca29_b651e8016689
  style 281944dd_c9ab_27a8_fd24_20b3c5b86a80 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql2/session.ts lines 331–349

	override async transaction<T>(transaction: (tx: MySql2Transaction<TFullSchema, TSchema>) => Promise<T>): Promise<T> {
		const savepointName = `sp${this.nestedIndex + 1}`;
		const tx = new MySql2Transaction<TFullSchema, TSchema>(
			this.dialect,
			this.session,
			this.schema,
			this.nestedIndex + 1,
			this.mode,
		);
		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;
		}
	}