session.ts — drizzle-orm Source File

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

File typescript DrizzleORM QueryBuilders 14 imports 1 dependents 3 classes

Entity Profile

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

Dependency Diagram

graph LR
  8c075175_ed31_3ec7_952e_c0a6558abc34["session.ts"]
  e9867962_df5d_03c5_8e49_973b2b1a930a["serverless"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> e9867962_df5d_03c5_8e49_973b2b1a930a
  4dc3ba08_25aa_13fd_82c6_8802d5991d05["batch.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> 4dc3ba08_25aa_13fd_82c6_8802d5991d05
  363fdd67_2503_7ef7_e1f3_a1ef31694431["index.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> 363fdd67_2503_7ef7_e1f3_a1ef31694431
  47a9c453_10f1_a759_6246_695fcce2b20a["types.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> 47a9c453_10f1_a759_6246_695fcce2b20a
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> 220c512d_350b_24bf_2142_53ec35a980ac
  65dc222f_bc11_439f_d65b_20d7052b24ec["dialect.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> 65dc222f_bc11_439f_d65b_20d7052b24ec
  fa14e9c0_b73d_4bcb_463b_adf18df8a285["index.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> fa14e9c0_b73d_4bcb_463b_adf18df8a285
  79ece9bc_4c30_3a6b_c173_2b7b1842a99b["select.types.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> 79ece9bc_4c30_3a6b_c173_2b7b1842a99b
  0e227879_31b1_8596_726d_80119efbf846["session.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> 0e227879_31b1_8596_726d_80119efbf846
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  547e9370_8c5e_e9f1_3d6f_b9a83ab3d562["session.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> 547e9370_8c5e_e9f1_3d6f_b9a83ab3d562
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  8c075175_ed31_3ec7_952e_c0a6558abc34 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  style 8c075175_ed31_3ec7_952e_c0a6558abc34 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { FullQueryResults, NeonQueryFunction, NeonQueryPromise } from '@neondatabase/serverless';
import type { BatchItem } from '~/batch.ts';
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 { PgDialect } from '~/pg-core/dialect.ts';
import { PgTransaction } from '~/pg-core/index.ts';
import type { SelectedFieldsOrdered } from '~/pg-core/query-builders/select.types.ts';
import type { PgQueryResultHKT, PgTransactionConfig, PreparedQueryConfig } from '~/pg-core/session.ts';
import { PgPreparedQuery as PgPreparedQuery, PgSession } from '~/pg-core/session.ts';
import type { RelationalSchemaConfig, TablesRelationalConfig } from '~/relations.ts';
import type { PreparedQuery } from '~/session.ts';
import { fillPlaceholders, type Query, type SQL } from '~/sql/sql.ts';
import { mapResultRow, type NeonAuthToken } from '~/utils.ts';

export type NeonHttpClient = NeonQueryFunction<any, any>;

const rawQueryConfig = {
	arrayMode: false,
	fullResults: true,
} as const;
const queryConfig = {
	arrayMode: true,
	fullResults: true,
} as const;

export class NeonHttpPreparedQuery<T extends PreparedQueryConfig> extends PgPreparedQuery<T> {
	static override readonly [entityKind]: string = 'NeonHttpPreparedQuery';
	private clientQuery: (sql: string, params: any[], opts: Record<string, any>) => NeonQueryPromise<any, any>;

	constructor(
		private client: NeonHttpClient,
		query: Query,
		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'],
	) {
		super(query, cache, queryMetadata, cacheConfig);
		// `client.query` is for @neondatabase/serverless v1.0.0 and up, where the
		// root query function `client` is only usable as a template function;
		// `client` is a fallback for earlier versions
		this.clientQuery = (client as any).query ?? client as any;
	}

	async execute(placeholderValues: Record<string, unknown> | undefined): Promise<T['execute']>;
	/** @internal */
	async execute(placeholderValues: Record<string, unknown> | undefined, token?: NeonAuthToken): Promise<T['execute']>;
	/** @internal */
	async execute(
		placeholderValues: Record<string, unknown> | undefined = {},
		token: NeonAuthToken | undefined = this.authToken,
// ... (224 more lines)