driver.ts — drizzle-orm Source File

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

File typescript DrizzleORM QueryBuilders 12 imports 1 dependents 4 functions 2 classes

Entity Profile

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

Dependency Diagram

graph LR
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc["driver.ts"]
  62c65d67_46f9_0c5c_7e91_734bbcfd68cd["session.ts"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> 62c65d67_46f9_0c5c_7e91_734bbcfd68cd
  e9d8b7b5_1910_1bff_8151_cd5dc7990756["SingleStoreDriverSession"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> e9d8b7b5_1910_1bff_8151_cd5dc7990756
  e1b1f49f_839a_f414_dd91_58d1ba77668f["mysql2"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> e1b1f49f_839a_f414_dd91_58d1ba77668f
  a340f455_7575_91f4_791a_10cd9b9dba1a["promise"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> a340f455_7575_91f4_791a_10cd9b9dba1a
  4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4["cache.ts"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> 4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  464acff4_0949_be30_6c79_3d0b1523ba16["db.ts"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> 464acff4_0949_be30_6c79_3d0b1523ba16
  e0cf6f45_6d77_2e69_af64_53d1b57b73fe["dialect.ts"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> e0cf6f45_6d77_2e69_af64_53d1b57b73fe
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  55b8862d_43ed_5f90_f168_b7cf3a56bf2d["version.ts"]
  e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc --> 55b8862d_43ed_5f90_f168_b7cf3a56bf2d
  4f5e56a0_1d30_6293_2bd2_549bdc7109c1["migrator.ts"]
  4f5e56a0_1d30_6293_2bd2_549bdc7109c1 --> e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc
  style e9bcf6d5_8150_e6fa_afb8_81b1cb833dcc fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { type Connection as CallbackConnection, createPool, type Pool as CallbackPool, type PoolOptions } from 'mysql2';
import type { Connection, Pool } from 'mysql2/promise';
import type { Cache } from '~/cache/core/cache.ts';
import { entityKind } from '~/entity.ts';
import type { Logger } from '~/logger.ts';
import { DefaultLogger } from '~/logger.ts';
import {
	createTableRelationsHelpers,
	extractTablesRelationalConfig,
	type RelationalSchemaConfig,
	type TablesRelationalConfig,
} from '~/relations.ts';
import { SingleStoreDatabase } from '~/singlestore-core/db.ts';
import { SingleStoreDialect } from '~/singlestore-core/dialect.ts';
import { type DrizzleConfig, isConfig } from '~/utils.ts';
import { npmVersion } from '~/version.ts';
import type {
	SingleStoreDriverClient,
	SingleStoreDriverPreparedQueryHKT,
	SingleStoreDriverQueryResultHKT,
} from './session.ts';
import { SingleStoreDriverSession } from './session.ts';

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

export class SingleStoreDriverDriver {
	static readonly [entityKind]: string = 'SingleStoreDriverDriver';

	constructor(
		private client: SingleStoreDriverClient,
		private dialect: SingleStoreDialect,
		private options: SingleStoreDriverOptions = {},
	) {
	}

	createSession(
		schema: RelationalSchemaConfig<TablesRelationalConfig> | undefined,
	): SingleStoreDriverSession<Record<string, unknown>, TablesRelationalConfig> {
		return new SingleStoreDriverSession(this.client, this.dialect, schema, {
			logger: this.options.logger,
			cache: this.options.cache,
		});
	}
}

export { SingleStoreDatabase } from '~/singlestore-core/db.ts';

export class SingleStoreDriverDatabase<
	TSchema extends Record<string, unknown> = Record<string, never>,
> extends SingleStoreDatabase<SingleStoreDriverQueryResultHKT, SingleStoreDriverPreparedQueryHKT, TSchema> {
	static override readonly [entityKind]: string = 'SingleStoreDriverDatabase';
}

export type SingleStoreDriverDrizzleConfig<TSchema extends Record<string, unknown> = Record<string, never>> =
	& Omit<DrizzleConfig<TSchema>, 'schema'>
	& ({ schema: TSchema } | { schema?: undefined });

// ... (135 more lines)