drizzle-orm Architecture Docs
Home / File/ driver.ts — drizzle-orm Source File

driver.ts — drizzle-orm Source File

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

File typescript DrizzleORM DatabaseDrivers 9 imports 1 dependents 3 functions 1 classes

Entity Profile

Dependency Diagram

graph LR
  3ae74e9d_9ef5_2553_ca81_fae936d635ca["driver.ts"]
  baed709d_8779_aa82_55d7_015a29a37065["session.ts"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca --> baed709d_8779_aa82_55d7_015a29a37065
  116b9e1a_aec8_0e35_a7cb_40d3a24bc48c["TiDBServerlessSession"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca --> 116b9e1a_aec8_0e35_a7cb_40d3a24bc48c
  b02a037b_0c99_6322_ae9e_c7e11ee45713["serverless"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca --> b02a037b_0c99_6322_ae9e_c7e11ee45713
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca --> 220c512d_350b_24bf_2142_53ec35a980ac
  cffd352b_ee7e_3520_6232_dcb292268798["db.ts"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca --> cffd352b_ee7e_3520_6232_dcb292268798
  8e1e9852_05bf_563a_0455_d59c9d25a84e["dialect.ts"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca --> 8e1e9852_05bf_563a_0455_d59c9d25a84e
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  3ae74e9d_9ef5_2553_ca81_fae936d635ca --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  6b301a43_1d4a_8f85_54a7_3bd94ae96201["migrator.ts"]
  6b301a43_1d4a_8f85_54a7_3bd94ae96201 --> 3ae74e9d_9ef5_2553_ca81_fae936d635ca
  style 3ae74e9d_9ef5_2553_ca81_fae936d635ca fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { type Config, connect, type Connection } from '@tidbcloud/serverless';
import { entityKind } from '~/entity.ts';
import type { Logger } from '~/logger.ts';
import { DefaultLogger } from '~/logger.ts';
import { MySqlDatabase } from '~/mysql-core/db.ts';
import { MySqlDialect } from '~/mysql-core/dialect.ts';
import {
	createTableRelationsHelpers,
	extractTablesRelationalConfig,
	type RelationalSchemaConfig,
	type TablesRelationalConfig,
} from '~/relations.ts';
import { type DrizzleConfig, isConfig } from '~/utils.ts';
import type { TiDBServerlessPreparedQueryHKT, TiDBServerlessQueryResultHKT } from './session.ts';
import { TiDBServerlessSession } from './session.ts';

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

export class TiDBServerlessDatabase<
	TSchema extends Record<string, unknown> = Record<string, never>,
> extends MySqlDatabase<TiDBServerlessQueryResultHKT, TiDBServerlessPreparedQueryHKT, TSchema> {
	static override readonly [entityKind]: string = 'TiDBServerlessDatabase';
}

function construct<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: Connection,
	config: DrizzleConfig<TSchema> = {},
): TiDBServerlessDatabase<TSchema> & {
	$client: Connection;
} {
	const dialect = new MySqlDialect({ casing: config.casing });
	let logger;
	if (config.logger === true) {
		logger = new DefaultLogger();
	} else if (config.logger !== false) {
		logger = config.logger;
	}

	let schema: RelationalSchemaConfig<TablesRelationalConfig> | undefined;
	if (config.schema) {
		const tablesConfig = extractTablesRelationalConfig(
			config.schema,
			createTableRelationsHelpers,
		);
		schema = {
			fullSchema: config.schema,
			schema: tablesConfig.tables,
			tableNamesMap: tablesConfig.tableNamesMap,
		};
	}

	const session = new TiDBServerlessSession(client, dialect, undefined, schema, { logger, cache: config.cache });
	const db = new TiDBServerlessDatabase(dialect, session, schema as any, 'default') as TiDBServerlessDatabase<TSchema>;
	(<any> db).$client = client;
	(<any> db).$cache = config.cache;
	if ((<any> db).$cache) {
		(<any> db).$cache['invalidate'] = config.cache?.onMutate;
// ... (62 more lines)

Domain

Subdomains

Functions

Classes

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does driver.ts do?
driver.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 driver.ts?
driver.ts defines 3 function(s): construct, drizzle, mock.
What does driver.ts depend on?
driver.ts imports 9 module(s): TiDBServerlessSession, db.ts, dialect.ts, entity.ts, logger.ts, relations.ts, serverless, session.ts, and 1 more.
What files import driver.ts?
driver.ts is imported by 1 file(s): migrator.ts.
Where is driver.ts in the architecture?
driver.ts is located at drizzle-orm/src/tidb-serverless/driver.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/tidb-serverless).

Analyze Your Own Codebase

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

Try Supermodel Free