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

Entity Profile

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

Dependency Diagram

graph LR
  053b47f2_f302_5369_9ab2_7667cbadf49f["driver.ts"]
  18315257_3b48_a60d_f8cf_ea5ba47f9fd5["session.ts"]
  053b47f2_f302_5369_9ab2_7667cbadf49f --> 18315257_3b48_a60d_f8cf_ea5ba47f9fd5
  0a6098e5_e35f_dbf4_acfc_717471d58678["BunSQLSession"]
  053b47f2_f302_5369_9ab2_7667cbadf49f --> 0a6098e5_e35f_dbf4_acfc_717471d58678
  3566df6c_fc73_10e3_ceca_d9d9b2ec98b1["bun"]
  053b47f2_f302_5369_9ab2_7667cbadf49f --> 3566df6c_fc73_10e3_ceca_d9d9b2ec98b1
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  053b47f2_f302_5369_9ab2_7667cbadf49f --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  053b47f2_f302_5369_9ab2_7667cbadf49f --> 220c512d_350b_24bf_2142_53ec35a980ac
  84b656ff_244f_df0f_a4a0_653292f28349["db.ts"]
  053b47f2_f302_5369_9ab2_7667cbadf49f --> 84b656ff_244f_df0f_a4a0_653292f28349
  65dc222f_bc11_439f_d65b_20d7052b24ec["dialect.ts"]
  053b47f2_f302_5369_9ab2_7667cbadf49f --> 65dc222f_bc11_439f_d65b_20d7052b24ec
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  053b47f2_f302_5369_9ab2_7667cbadf49f --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  053b47f2_f302_5369_9ab2_7667cbadf49f --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  98afda93_15f8_4904_1f03_53120c7577f4["migrator.ts"]
  98afda93_15f8_4904_1f03_53120c7577f4 --> 053b47f2_f302_5369_9ab2_7667cbadf49f
  style 053b47f2_f302_5369_9ab2_7667cbadf49f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

/// <reference types="bun-types" />

import type { SQLOptions } from 'bun';
import { SQL } from 'bun';
import { entityKind } from '~/entity.ts';
import { DefaultLogger } from '~/logger.ts';
import { PgDatabase } from '~/pg-core/db.ts';
import { PgDialect } from '~/pg-core/dialect.ts';
import {
	createTableRelationsHelpers,
	extractTablesRelationalConfig,
	type RelationalSchemaConfig,
	type TablesRelationalConfig,
} from '~/relations.ts';
import { type DrizzleConfig, isConfig } from '~/utils.ts';
import type { BunSQLQueryResultHKT } from './session.ts';
import { BunSQLSession } from './session.ts';

export class BunSQLDatabase<
	TSchema extends Record<string, unknown> = Record<string, never>,
> extends PgDatabase<BunSQLQueryResultHKT, TSchema> {
	static override readonly [entityKind]: string = 'BunSQLDatabase';
}

function construct<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: SQL,
	config: DrizzleConfig<TSchema> = {},
): BunSQLDatabase<TSchema> & {
	$client: SQL;
} {
	const dialect = new PgDialect({ 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 BunSQLSession(client, dialect, schema, { logger, cache: config.cache });
	const db = new BunSQLDatabase(dialect, session, schema as any) as BunSQLDatabase<TSchema>;
	(<any> db).$client = client;
	(<any> db).$cache = config.cache;
	if ((<any> db).$cache) {
		(<any> db).$cache['invalidate'] = config.cache?.onMutate;
	}

	return db as any;
// ... (67 more lines)