transaction() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers calls 3 called by 1

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/mysql2/session.ts lines 281–322

	override async transaction<T>(
		transaction: (tx: MySql2Transaction<TFullSchema, TSchema>) => Promise<T>,
		config?: MySqlTransactionConfig,
	): Promise<T> {
		const session = isPool(this.client)
			? new MySql2Session(
				await this.client.getConnection(),
				this.dialect,
				this.schema,
				this.options,
			)
			: this;
		const tx = new MySql2Transaction<TFullSchema, TSchema>(
			this.dialect,
			session as MySqlSession<any, any, any, any>,
			this.schema,
			0,
			this.mode,
		);
		if (config) {
			const setTransactionConfigSql = this.getSetTransactionSQL(config);
			if (setTransactionConfigSql) {
				await tx.execute(setTransactionConfigSql);
			}
			const startTransactionSql = this.getStartTransactionSQL(config);
			await (startTransactionSql ? tx.execute(startTransactionSql) : tx.execute(sql`begin`));
		} else {
			await tx.execute(sql`begin`);
		}
		try {
			const result = await transaction(tx);
			await tx.execute(sql`commit`);
			return result;
		} catch (err) {
			await tx.execute(sql`rollback`);
			throw err;
		} finally {
			if (isPool(this.client)) {
				(session.client as PoolConnection).release();
			}
		}
	}