session.ts — drizzle-orm Source File

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

File typescript DrizzleORM DatabaseDrivers 13 imports 4 dependents 2 functions

Entity Profile

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

Dependency Diagram

graph LR
  ed278e34_87d5_45ca_9ac1_16137c36228f["session.ts"]
  99d4b8a7_e046_2f16_afff_9a25e87a12c1["db.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> 99d4b8a7_e046_2f16_afff_9a25e87a12c1
  7b170b6b_8109_4580_dc12_4da0d59d8d8d["PgDatabase"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> 7b170b6b_8109_4580_dc12_4da0d59d8d8d
  f5d8a5f9_df11_57a8_8f3f_88924e501a7c["dialect.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> f5d8a5f9_df11_57a8_8f3f_88924e501a7c
  65d45edf_0d8a_b7f0_1780_573c12d9a0e6["select.types.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> 65d45edf_0d8a_b7f0_1780_573c12d9a0e6
  4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4["cache.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> 4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4
  47a9c453_10f1_a759_6246_695fcce2b20a["types.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> 47a9c453_10f1_a759_6246_695fcce2b20a
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  a633174a_152a_5e1c_73b0_aa56a1f1c3c5["errors.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> a633174a_152a_5e1c_73b0_aa56a1f1c3c5
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  547e9370_8c5e_e9f1_3d6f_b9a83ab3d562["session.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> 547e9370_8c5e_e9f1_3d6f_b9a83ab3d562
  944a2bed_8787_5f43_03e5_9a3b696c293c["index.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> 944a2bed_8787_5f43_03e5_9a3b696c293c
  051cc2d2_fe6f_16df_aaec_3b341d2c2576["tracing.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> 051cc2d2_fe6f_16df_aaec_3b341d2c2576
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  ed278e34_87d5_45ca_9ac1_16137c36228f --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  f5d8a5f9_df11_57a8_8f3f_88924e501a7c["dialect.ts"]
  f5d8a5f9_df11_57a8_8f3f_88924e501a7c --> ed278e34_87d5_45ca_9ac1_16137c36228f
  fa6a01b7_6d1f_e5fb_2daa_b614b6687cb0["count.ts"]
  fa6a01b7_6d1f_e5fb_2daa_b614b6687cb0 --> ed278e34_87d5_45ca_9ac1_16137c36228f
  style ed278e34_87d5_45ca_9ac1_16137c36228f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { type Cache, hashQuery, NoopCache } from '~/cache/core/cache.ts';
import type { WithCacheConfig } from '~/cache/core/types.ts';
import { entityKind, is } from '~/entity.ts';
import { DrizzleQueryError, TransactionRollbackError } from '~/errors.ts';
import type { TablesRelationalConfig } from '~/relations.ts';
import type { PreparedQuery } from '~/session.ts';
import { type Query, type SQL, sql } from '~/sql/index.ts';
import { tracer } from '~/tracing.ts';
import type { NeonAuthToken } from '~/utils.ts';
import { PgDatabase } from './db.ts';
import type { PgDialect } from './dialect.ts';
import type { SelectedFieldsOrdered } from './query-builders/select.types.ts';

export interface PreparedQueryConfig {
	execute: unknown;
	all: unknown;
	values: unknown;
}

export abstract class PgPreparedQuery<T extends PreparedQueryConfig> implements PreparedQuery {
	constructor(
		protected query: Query,
		// cache instance
		private cache: Cache | undefined,
		// per query related metadata
		private queryMetadata: {
			type: 'select' | 'update' | 'delete' | 'insert';
			tables: string[];
		} | undefined,
		// config that was passed through $withCache
		private cacheConfig?: WithCacheConfig,
	) {
		// it means that no $withCache options were passed and it should be just enabled
		if (cache && cache.strategy() === 'all' && cacheConfig === undefined) {
			this.cacheConfig = { enable: true, autoInvalidate: true };
		}
		if (!this.cacheConfig?.enable) {
			this.cacheConfig = undefined;
		}
	}

	protected authToken?: NeonAuthToken;

	getQuery(): Query {
		return this.query;
	}

	mapResult(response: unknown, _isFromBatch?: boolean): unknown {
		return response;
	}

	/** @internal */
	setToken(token?: NeonAuthToken) {
		this.authToken = token;
		return this;
	}

	static readonly [entityKind]: string = 'PgPreparedQuery';

	/** @internal */
// ... (233 more lines)

Domain

DrizzleORM

Subdomains

DatabaseDrivers

Functions

Types

Dependencies

PgDatabase
cache.ts
db.ts
dialect.ts
entity.ts
errors.ts
index.ts
relations.ts
select.types.ts
session.ts
tracing.ts
types.ts
utils.ts

Imported By

Source

View on GitHub

Frequently Asked Questions

What does session.ts do?

session.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, DatabaseDrivers subdomain.

What functions are defined in session.ts?

session.ts defines 2 function(s): rows, tx.

What does session.ts depend on?

session.ts imports 13 module(s): PgDatabase, cache.ts, db.ts, dialect.ts, entity.ts, errors.ts, index.ts, relations.ts, and 5 more.

What files import session.ts?

session.ts is imported by 4 file(s): count.ts, dialect.ts, query.ts, select.types.ts.

Where is session.ts in the architecture?

session.ts is located at drizzle-orm/src/pg-core/session.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/pg-core).

Analyze Your Own Codebase

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

Try Supermodel Free