Home / Class/ SQLJsSession Class — drizzle-orm Architecture

SQLJsSession Class — drizzle-orm Architecture

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

Entity Profile

Dependency Diagram

graph TD
  6e5968f3_3f01_5fbb_b14b_e64c88c7916a["SQLJsSession"]
  058d4164_8a6e_e307_11eb_23f5c52611d5["session.ts"]
  6e5968f3_3f01_5fbb_b14b_e64c88c7916a -->|defined in| 058d4164_8a6e_e307_11eb_23f5c52611d5
  5bdac8d5_fcfc_39fd_0f5a_9b687754ea1e["constructor()"]
  6e5968f3_3f01_5fbb_b14b_e64c88c7916a -->|method| 5bdac8d5_fcfc_39fd_0f5a_9b687754ea1e
  47f2c28f_1953_8bb0_ba0c_ef512959b68f["prepareQuery()"]
  6e5968f3_3f01_5fbb_b14b_e64c88c7916a -->|method| 47f2c28f_1953_8bb0_ba0c_ef512959b68f
  64c77bc2_2026_921b_fd5a_d62bfc217ad6["transaction()"]
  6e5968f3_3f01_5fbb_b14b_e64c88c7916a -->|method| 64c77bc2_2026_921b_fd5a_d62bfc217ad6

Relationship Graph

Source Code

drizzle-orm/src/sql-js/session.ts lines 24–66

export class SQLJsSession<
	TFullSchema extends Record<string, unknown>,
	TSchema extends TablesRelationalConfig,
> extends SQLiteSession<'sync', void, TFullSchema, TSchema> {
	static override readonly [entityKind]: string = 'SQLJsSession';

	private logger: Logger;

	constructor(
		private client: Database,
		dialect: SQLiteSyncDialect,
		private schema: RelationalSchemaConfig<TSchema> | undefined,
		options: SQLJsSessionOptions = {},
	) {
		super(dialect);
		this.logger = options.logger ?? new NoopLogger();
	}

	prepareQuery<T extends Omit<PreparedQueryConfig, 'run'>>(
		query: Query,
		fields: SelectedFieldsOrdered | undefined,
		executeMethod: SQLiteExecuteMethod,
		isResponseInArrayMode: boolean,
	): PreparedQuery<T> {
		return new PreparedQuery(this.client, query, this.logger, fields, executeMethod, isResponseInArrayMode);
	}

	override transaction<T>(
		transaction: (tx: SQLJsTransaction<TFullSchema, TSchema>) => T,
		config: SQLiteTransactionConfig = {},
	): T {
		const tx = new SQLJsTransaction('sync', this.dialect, this, this.schema);
		this.run(sql.raw(`begin${config.behavior ? ` ${config.behavior}` : ''}`));
		try {
			const result = transaction(tx);
			this.run(sql`commit`);
			return result;
		} catch (err) {
			this.run(sql`rollback`);
			throw err;
		}
	}
}

Domain

Frequently Asked Questions

What is the SQLJsSession class?
SQLJsSession is a class in the drizzle-orm codebase, defined in drizzle-orm/src/sql-js/session.ts.
Where is SQLJsSession defined?
SQLJsSession is defined in drizzle-orm/src/sql-js/session.ts at line 24.

Analyze Your Own Codebase

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

Try Supermodel Free