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 SQLDialects 14 imports 1 dependents 3 classes

Entity Profile

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

Dependency Diagram

graph LR
  06097e19_bcad_7d24_ee80_bf451d27455d["session.ts"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31["driver.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> a4f01161_60cf_cee3_f86f_bc51f0eacf31
  a340f455_7575_91f4_791a_10cd9b9dba1a["promise"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> a340f455_7575_91f4_791a_10cd9b9dba1a
  363fdd67_2503_7ef7_e1f3_a1ef31694431["index.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> 363fdd67_2503_7ef7_e1f3_a1ef31694431
  47a9c453_10f1_a759_6246_695fcce2b20a["types.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> 47a9c453_10f1_a759_6246_695fcce2b20a
  05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> 05f0a280_d0c9_693a_a4bf_83cc671012d2
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> 220c512d_350b_24bf_2142_53ec35a980ac
  8e1e9852_05bf_563a_0455_d59c9d25a84e["dialect.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> 8e1e9852_05bf_563a_0455_d59c9d25a84e
  1da0a48e_f7fe_5ea4_cee2_3ed7d3f39f31["index.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> 1da0a48e_f7fe_5ea4_cee2_3ed7d3f39f31
  8d6c2a88_02dc_58ca_3b5b_21d95d5cbfee["select.types.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> 8d6c2a88_02dc_58ca_3b5b_21d95d5cbfee
  41e092f8_b812_732d_b00f_7596b41fc839["session.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> 41e092f8_b812_732d_b00f_7596b41fc839
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  style 06097e19_bcad_7d24_ee80_bf451d27455d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { FieldPacket, ResultSetHeader } from 'mysql2/promise';
import { type Cache, NoopCache } from '~/cache/core/index.ts';
import type { WithCacheConfig } from '~/cache/core/types.ts';
import { Column } from '~/column.ts';
import { entityKind, is } from '~/entity.ts';
import type { Logger } from '~/logger.ts';
import { NoopLogger } from '~/logger.ts';
import type { MySqlDialect } from '~/mysql-core/dialect.ts';
import { MySqlTransaction } from '~/mysql-core/index.ts';
import type { SelectedFieldsOrdered } from '~/mysql-core/query-builders/select.types.ts';
import type {
	MySqlPreparedQueryConfig,
	MySqlPreparedQueryHKT,
	MySqlQueryResultHKT,
	MySqlTransactionConfig,
	PreparedQueryKind,
} from '~/mysql-core/session.ts';
import { MySqlPreparedQuery as PreparedQueryBase, MySqlSession } from '~/mysql-core/session.ts';
import type { RelationalSchemaConfig, TablesRelationalConfig } from '~/relations.ts';
import { fillPlaceholders } from '~/sql/sql.ts';
import type { Query, SQL } from '~/sql/sql.ts';
import { type Assume, mapResultRow } from '~/utils.ts';
import type { RemoteCallback } from './driver.ts';

export type MySqlRawQueryResult = [ResultSetHeader, FieldPacket[]];

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

export class MySqlRemoteSession<
	TFullSchema extends Record<string, unknown>,
	TSchema extends TablesRelationalConfig,
> extends MySqlSession<MySqlRemoteQueryResultHKT, MySqlRemotePreparedQueryHKT, TFullSchema, TSchema> {
	static override readonly [entityKind]: string = 'MySqlRemoteSession';

	private logger: Logger;
	private cache: Cache;

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

	prepareQuery<T extends MySqlPreparedQueryConfig>(
		query: Query,
		fields: SelectedFieldsOrdered | undefined,
		customResultMapper?: (rows: unknown[][]) => T['execute'],
		generatedIds?: Record<string, unknown>[],
		returningIds?: SelectedFieldsOrdered,
		queryMetadata?: {
			type: 'select' | 'update' | 'delete' | 'insert';
			tables: string[];
// ... (137 more lines)