session.ts — drizzle-orm Source File

Architecture documentation for session.ts, a typescript file in the drizzle-orm codebase. 10 imports, 1 dependents.

File typescript DrizzleORM SQLDialects 10 imports 1 dependents 1 functions 3 classes

Entity Profile

DrizzleORM→ SQLDialects→ session.ts — drizzle-orm Source File

Dependency Diagram

graph LR
  058d4164_8a6e_e307_11eb_23f5c52611d5["session.ts"]
  e3b6939f_7479_645e_3a63_79763ad4c27c["sql.js"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> e3b6939f_7479_645e_3a63_79763ad4c27c
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> 3d205d67_2ef4_984a_3241_ff4981527231
  c9460fa2_b68e_584b_2be3_a4db38ea6f7c["index.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> c9460fa2_b68e_584b_2be3_a4db38ea6f7c
  bf02be20_6959_f396_18fe_977324363c59["select.types.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> bf02be20_6959_f396_18fe_977324363c59
  21edec30_3c3a_04cb_9bbe_28adfc576bfb["session.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> 21edec30_3c3a_04cb_9bbe_28adfc576bfb
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  5f134997_2cad_bdb1_00ab_4ea928547b4e["driver.ts"]
  5f134997_2cad_bdb1_00ab_4ea928547b4e --> 058d4164_8a6e_e307_11eb_23f5c52611d5
  style 058d4164_8a6e_e307_11eb_23f5c52611d5 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { BindParams, Database } from 'sql.js';
import { entityKind } from '~/entity.ts';
import type { Logger } from '~/logger.ts';
import { NoopLogger } from '~/logger.ts';
import type { RelationalSchemaConfig, TablesRelationalConfig } from '~/relations.ts';
import { fillPlaceholders, type Query, sql } from '~/sql/sql.ts';
import type { SQLiteSyncDialect } from '~/sqlite-core/dialect.ts';
import { SQLiteTransaction } from '~/sqlite-core/index.ts';
import type { SelectedFieldsOrdered } from '~/sqlite-core/query-builders/select.types.ts';
import type {
	PreparedQueryConfig as PreparedQueryConfigBase,
	SQLiteExecuteMethod,
	SQLiteTransactionConfig,
} from '~/sqlite-core/session.ts';
import { SQLitePreparedQuery as PreparedQueryBase, SQLiteSession } from '~/sqlite-core/session.ts';
import { mapResultRow } from '~/utils.ts';

export interface SQLJsSessionOptions {
	logger?: Logger;
}

type PreparedQueryConfig = Omit<PreparedQueryConfigBase, 'statement' | 'run'>;

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;
// ... (152 more lines)