session.ts — drizzle-orm Source File

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

File typescript DrizzleORM RelationalQuery 13 imports 1 dependents 3 classes

Entity Profile

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

Dependency Diagram

graph LR
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0["session.ts"]
  90067f6e_33cd_67c4_3575_3758cdacb6e2["gel"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> 90067f6e_33cd_67c4_3575_3758cdacb6e2
  20af1ba5_e888_b5a8_c4c0_18c4440a6516["transaction"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> 20af1ba5_e888_b5a8_c4c0_18c4440a6516
  363fdd67_2503_7ef7_e1f3_a1ef31694431["index.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> 363fdd67_2503_7ef7_e1f3_a1ef31694431
  47a9c453_10f1_a759_6246_695fcce2b20a["types.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> 47a9c453_10f1_a759_6246_695fcce2b20a
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  f86d3f7c_7b46_5b9f_94e2_ac0a5f48d903["dialect.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> f86d3f7c_7b46_5b9f_94e2_ac0a5f48d903
  035a2c62_254b_e601_6cb4_e30799787a12["select.types.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> 035a2c62_254b_e601_6cb4_e30799787a12
  90dfe595_29ab_0495_4263_3b19b4bb4d9b["session.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> 90dfe595_29ab_0495_4263_3b19b4bb4d9b
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  051cc2d2_fe6f_16df_aaec_3b341d2c2576["tracing.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> 051cc2d2_fe6f_16df_aaec_3b341d2c2576
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  612dbe90_48c8_5f9e_1685_3ec048012649["driver.ts"]
  612dbe90_48c8_5f9e_1685_3ec048012649 --> 40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0
  style 40439e01_0b0d_d1ca_8a6c_cc21c23b9ce0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { Client } from 'gel';
import type { Transaction } from 'gel/dist/transaction';
import { type Cache, NoopCache } from '~/cache/core/index.ts';
import type { WithCacheConfig } from '~/cache/core/types.ts';
import { entityKind } from '~/entity.ts';
import type { GelDialect } from '~/gel-core/dialect.ts';
import type { SelectedFieldsOrdered } from '~/gel-core/query-builders/select.types.ts';
import { GelPreparedQuery, GelSession, GelTransaction, type PreparedQueryConfig } from '~/gel-core/session.ts';
import { type Logger, NoopLogger } from '~/logger.ts';
import type { RelationalSchemaConfig, TablesRelationalConfig } from '~/relations.ts';
import { fillPlaceholders, type Query, type SQL } from '~/sql/sql.ts';
import { tracer } from '~/tracing.ts';
import { mapResultRow } from '~/utils.ts';

export type GelClient = Client | Transaction;

export class GelDbPreparedQuery<T extends PreparedQueryConfig> extends GelPreparedQuery<T> {
	static override readonly [entityKind]: string = 'GelPreparedQuery';

	constructor(
		private client: GelClient,
		private queryString: string,
		private params: unknown[],
		private logger: Logger,
		cache: Cache,
		queryMetadata: {
			type: 'select' | 'update' | 'delete' | 'insert';
			tables: string[];
		} | undefined,
		cacheConfig: WithCacheConfig | undefined,
		private fields: SelectedFieldsOrdered | undefined,
		private _isResponseInArrayMode: boolean,
		private customResultMapper?: (rows: unknown[][]) => T['execute'],
		private transaction: boolean = false,
	) {
		super({ sql: queryString, params }, cache, queryMetadata, cacheConfig);
	}

	async execute(placeholderValues: Record<string, unknown> | undefined = {}): Promise<T['execute']> {
		return tracer.startActiveSpan('drizzle.execute', async () => {
			const params = fillPlaceholders(this.params, placeholderValues);

			this.logger.logQuery(this.queryString, params);
			const { fields, queryString: query, client, joinsNotNullableMap, customResultMapper } = this;
			if (!fields && !customResultMapper) {
				return tracer.startActiveSpan('drizzle.driver.execute', async (span) => {
					span?.setAttributes({
						'drizzle.query.text': query,
						'drizzle.query.params': JSON.stringify(params),
					});

					return await this.queryWithCache(query, params, async () => {
						return await client.querySQL(query, params.length ? params : undefined);
					});
				});
			}

			const result = (await tracer.startActiveSpan('drizzle.driver.execute', async (span) => {
				span?.setAttributes({
					'drizzle.query.text': query,
// ... (131 more lines)