transaction() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery calls 3 called by 1

Entity Profile

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

Dependency Diagram

graph TD
  97e806e9_97b7_074b_ac57_aab19d4bbc66["transaction()"]
  e9d8b7b5_1910_1bff_8151_cd5dc7990756["SingleStoreDriverSession"]
  97e806e9_97b7_074b_ac57_aab19d4bbc66 -->|defined in| e9d8b7b5_1910_1bff_8151_cd5dc7990756
  8a26552d_acc1_0ef9_c339_f7c6004922f3["transaction()"]
  8a26552d_acc1_0ef9_c339_f7c6004922f3 -->|calls| 97e806e9_97b7_074b_ac57_aab19d4bbc66
  d4a863ce_a3bb_07aa_1d62_22fab05df51e["isPool()"]
  97e806e9_97b7_074b_ac57_aab19d4bbc66 -->|calls| d4a863ce_a3bb_07aa_1d62_22fab05df51e
  0f9540de_5358_69fd_b854_4371666724a9["execute()"]
  97e806e9_97b7_074b_ac57_aab19d4bbc66 -->|calls| 0f9540de_5358_69fd_b854_4371666724a9
  8a26552d_acc1_0ef9_c339_f7c6004922f3["transaction()"]
  97e806e9_97b7_074b_ac57_aab19d4bbc66 -->|calls| 8a26552d_acc1_0ef9_c339_f7c6004922f3
  style 97e806e9_97b7_074b_ac57_aab19d4bbc66 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore/session.ts lines 277–317

	override async transaction<T>(
		transaction: (tx: SingleStoreDriverTransaction<TFullSchema, TSchema>) => Promise<T>,
		config?: SingleStoreTransactionConfig,
	): Promise<T> {
		const session = isPool(this.client)
			? new SingleStoreDriverSession(
				await this.client.getConnection(),
				this.dialect,
				this.schema,
				this.options,
			)
			: this;
		const tx = new SingleStoreDriverTransaction<TFullSchema, TSchema>(
			this.dialect,
			session as SingleStoreSession<any, any, any, any>,
			this.schema,
			0,
		);
		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();
			}
		}
	}