driver.ts — drizzle-orm Source File

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

File typescript DrizzleORM SQLDialects 8 imports 2 dependents 2 functions 1 classes

Entity Profile

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

Dependency Diagram

graph LR
  a4f01161_60cf_cee3_f86f_bc51f0eacf31["driver.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d["session.ts"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31 --> 06097e19_bcad_7d24_ee80_bf451d27455d
  9b87d13f_b108_a6bb_f37d_c1cb86125580["MySqlRemoteSession"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31 --> 9b87d13f_b108_a6bb_f37d_c1cb86125580
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31 --> 220c512d_350b_24bf_2142_53ec35a980ac
  cffd352b_ee7e_3520_6232_dcb292268798["db.ts"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31 --> cffd352b_ee7e_3520_6232_dcb292268798
  8e1e9852_05bf_563a_0455_d59c9d25a84e["dialect.ts"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31 --> 8e1e9852_05bf_563a_0455_d59c9d25a84e
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  6933bae5_523d_5be5_3b7a_95ccd2623305["migrator.ts"]
  6933bae5_523d_5be5_3b7a_95ccd2623305 --> a4f01161_60cf_cee3_f86f_bc51f0eacf31
  06097e19_bcad_7d24_ee80_bf451d27455d["session.ts"]
  06097e19_bcad_7d24_ee80_bf451d27455d --> a4f01161_60cf_cee3_f86f_bc51f0eacf31
  style a4f01161_60cf_cee3_f86f_bc51f0eacf31 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind } from '~/entity.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 } from '~/utils.ts';
import { type MySqlRemotePreparedQueryHKT, type MySqlRemoteQueryResultHKT, MySqlRemoteSession } from './session.ts';

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

export type RemoteCallback = (
	sql: string,
	params: any[],
	method: 'all' | 'execute',
) => Promise<{ rows: any[]; insertId?: number; affectedRows?: number }>;

export function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
	callback: RemoteCallback,
	config: DrizzleConfig<TSchema> = {},
): MySqlRemoteDatabase<TSchema> {
	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 MySqlRemoteSession(callback, dialect, schema, { logger });
	return new MySqlRemoteDatabase(dialect, session, schema as any, 'default') as MySqlRemoteDatabase<TSchema>;
}