drizzle-orm Architecture Docs
Home / Class/ PlanetScaleTransaction Class — drizzle-orm Architecture

PlanetScaleTransaction Class — drizzle-orm Architecture

Architecture documentation for the PlanetScaleTransaction class in session.ts from the drizzle-orm codebase.

Class typescript DrizzleORM

Entity Profile

Dependency Diagram

graph TD
  53b78ffc_ad9b_9400_ddd7_0a343a1144bf["PlanetScaleTransaction"]
  e55f93a1_bb42_b29e_7f05_390a87b09427["session.ts"]
  53b78ffc_ad9b_9400_ddd7_0a343a1144bf -->|defined in| e55f93a1_bb42_b29e_7f05_390a87b09427
  d72a6981_da17_6e1f_5e9e_8d0d1146e7dc["constructor()"]
  53b78ffc_ad9b_9400_ddd7_0a343a1144bf -->|method| d72a6981_da17_6e1f_5e9e_8d0d1146e7dc
  b8fec522_2a54_80d3_4ec6_c807a719fed2["transaction()"]
  53b78ffc_ad9b_9400_ddd7_0a343a1144bf -->|method| b8fec522_2a54_80d3_4ec6_c807a719fed2

Relationship Graph

Source Code

drizzle-orm/src/planetscale-serverless/session.ts lines 213–248

export class PlanetScaleTransaction<
	TFullSchema extends Record<string, unknown>,
	TSchema extends TablesRelationalConfig,
> extends MySqlTransaction<PlanetscaleQueryResultHKT, PlanetScalePreparedQueryHKT, TFullSchema, TSchema> {
	static override readonly [entityKind]: string = 'PlanetScaleTransaction';

	constructor(
		dialect: MySqlDialect,
		session: MySqlSession,
		schema: RelationalSchemaConfig<TSchema> | undefined,
		nestedIndex = 0,
	) {
		super(dialect, session, schema, nestedIndex, 'planetscale');
	}

	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;
		}
	}
}

Domain

Defined In

Source

Frequently Asked Questions

What is the PlanetScaleTransaction class?
PlanetScaleTransaction is a class in the drizzle-orm codebase, defined in drizzle-orm/src/planetscale-serverless/session.ts.
Where is PlanetScaleTransaction defined?
PlanetScaleTransaction is defined in drizzle-orm/src/planetscale-serverless/session.ts at line 213.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free