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 1 functions 1 classes

Entity Profile

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

Dependency Diagram

graph LR
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf["driver.ts"]
  45f9aea4_1252_eb43_9fc8_0fff93550668["session.ts"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> 45f9aea4_1252_eb43_9fc8_0fff93550668
  a96c3d61_1d27_8a4f_e20c_2647f5908960["OPSQLiteSession"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> a96c3d61_1d27_8a4f_e20c_2647f5908960
  3389a0f5_34b1_fa08_8802_8853449f2fdd["op-sqlite"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> 3389a0f5_34b1_fa08_8802_8853449f2fdd
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  3a0d0431_7555_f390_0d6a_8a596d3416a8["db.ts"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> 3a0d0431_7555_f390_0d6a_8a596d3416a8
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> 3d205d67_2ef4_984a_3241_ff4981527231
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  83aa60fb_f2bc_7cbb_05d6_48650cc6facf --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  7d4ff80f_0ea3_5189_875c_e681d73995cd["migrator.ts"]
  7d4ff80f_0ea3_5189_875c_e681d73995cd --> 83aa60fb_f2bc_7cbb_05d6_48650cc6facf
  style 83aa60fb_f2bc_7cbb_05d6_48650cc6facf fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { OPSQLiteConnection, QueryResult } from '@op-engineering/op-sqlite';
import { entityKind } from '~/entity.ts';
import { DefaultLogger } from '~/logger.ts';
import {
	createTableRelationsHelpers,
	extractTablesRelationalConfig,
	type RelationalSchemaConfig,
	type TablesRelationalConfig,
} from '~/relations.ts';
import { BaseSQLiteDatabase } from '~/sqlite-core/db.ts';
import { SQLiteAsyncDialect } from '~/sqlite-core/dialect.ts';
import type { DrizzleConfig } from '~/utils.ts';
import { OPSQLiteSession } from './session.ts';

export class OPSQLiteDatabase<
	TSchema extends Record<string, unknown> = Record<string, never>,
> extends BaseSQLiteDatabase<'async', QueryResult, TSchema> {
	static override readonly [entityKind]: string = 'OPSQLiteDatabase';
}

export function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: OPSQLiteConnection,
	config: DrizzleConfig<TSchema> = {},
): OPSQLiteDatabase<TSchema> & {
	$client: OPSQLiteConnection;
} {
	const dialect = new SQLiteAsyncDialect({ 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 OPSQLiteSession(client, dialect, schema, { logger, cache: config.cache });
	const db = new OPSQLiteDatabase('async', dialect, session, schema) as OPSQLiteDatabase<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;
}