session.ts — drizzle-orm Source File

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

File typescript DrizzleORM SQLDialects 12 imports 1 dependents 3 classes

Entity Profile

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

Dependency Diagram

graph LR
  45f9aea4_1252_eb43_9fc8_0fff93550668["session.ts"]
  3389a0f5_34b1_fa08_8802_8853449f2fdd["op-sqlite"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> 3389a0f5_34b1_fa08_8802_8853449f2fdd
  363fdd67_2503_7ef7_e1f3_a1ef31694431["index.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> 363fdd67_2503_7ef7_e1f3_a1ef31694431
  47a9c453_10f1_a759_6246_695fcce2b20a["types.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> 47a9c453_10f1_a759_6246_695fcce2b20a
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> 3d205d67_2ef4_984a_3241_ff4981527231
  c9460fa2_b68e_584b_2be3_a4db38ea6f7c["index.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> c9460fa2_b68e_584b_2be3_a4db38ea6f7c
  bf02be20_6959_f396_18fe_977324363c59["select.types.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> bf02be20_6959_f396_18fe_977324363c59
  21edec30_3c3a_04cb_9bbe_28adfc576bfb["session.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> 21edec30_3c3a_04cb_9bbe_28adfc576bfb
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf["driver.ts"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> 45f9aea4_1252_eb43_9fc8_0fff93550668
  style 45f9aea4_1252_eb43_9fc8_0fff93550668 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { OPSQLiteConnection, QueryResult } from '@op-engineering/op-sqlite';
import { type Cache, NoopCache } from '~/cache/core/index.ts';
import type { WithCacheConfig } from '~/cache/core/types.ts';
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 { SQLiteAsyncDialect } 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,
	type SQLiteExecuteMethod,
	SQLitePreparedQuery,
	SQLiteSession,
	type SQLiteTransactionConfig,
} from '~/sqlite-core/session.ts';
import { mapResultRow } from '~/utils.ts';

export interface OPSQLiteSessionOptions {
	logger?: Logger;
	cache?: Cache;
}

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

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

	private logger: Logger;
	private cache: Cache;

	constructor(
		private client: OPSQLiteConnection,
		dialect: SQLiteAsyncDialect,
		private schema: RelationalSchemaConfig<TSchema> | undefined,
		options: OPSQLiteSessionOptions = {},
	) {
		super(dialect);
		this.logger = options.logger ?? new NoopLogger();
		this.cache = options.cache ?? new NoopCache();
	}

	prepareQuery<T extends Omit<PreparedQueryConfig, 'run'>>(
		query: Query,
		fields: SelectedFieldsOrdered | undefined,
		executeMethod: SQLiteExecuteMethod,
		isResponseInArrayMode: boolean,
		customResultMapper?: (rows: unknown[][]) => unknown,
		queryMetadata?: {
			type: 'select' | 'update' | 'delete' | 'insert';
			tables: string[];
		},
		cacheConfig?: WithCacheConfig,
	): OPSQLitePreparedQuery<T> {
		return new OPSQLitePreparedQuery(
// ... (140 more lines)