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
  01358773_a7b0_7445_a67e_caf8d8000855["driver.ts"]
  ddcc8973_fc9e_23b4_1e3c_d3ff67e9b7e4["session.ts"]
  01358773_a7b0_7445_a67e_caf8d8000855 --> ddcc8973_fc9e_23b4_1e3c_d3ff67e9b7e4
  33ba6b18_96d6_f163_e48c_66df08078cf2["ExpoSQLiteSession"]
  01358773_a7b0_7445_a67e_caf8d8000855 --> 33ba6b18_96d6_f163_e48c_66df08078cf2
  143ae12b_ee90_0583_ca71_70602b28741f["expo-sqlite"]
  01358773_a7b0_7445_a67e_caf8d8000855 --> 143ae12b_ee90_0583_ca71_70602b28741f
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  01358773_a7b0_7445_a67e_caf8d8000855 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  01358773_a7b0_7445_a67e_caf8d8000855 --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  01358773_a7b0_7445_a67e_caf8d8000855 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  3a0d0431_7555_f390_0d6a_8a596d3416a8["db.ts"]
  01358773_a7b0_7445_a67e_caf8d8000855 --> 3a0d0431_7555_f390_0d6a_8a596d3416a8
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  01358773_a7b0_7445_a67e_caf8d8000855 --> 3d205d67_2ef4_984a_3241_ff4981527231
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  01358773_a7b0_7445_a67e_caf8d8000855 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  0e92b232_8d9a_aa9d_3673_15b989e5e855["migrator.ts"]
  0e92b232_8d9a_aa9d_3673_15b989e5e855 --> 01358773_a7b0_7445_a67e_caf8d8000855
  style 01358773_a7b0_7445_a67e_caf8d8000855 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { SQLiteDatabase, SQLiteRunResult } from 'expo-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 { SQLiteSyncDialect } from '~/sqlite-core/dialect.ts';
import type { DrizzleConfig } from '~/utils.ts';
import { ExpoSQLiteSession } from './session.ts';

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

export function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: SQLiteDatabase,
	config: DrizzleConfig<TSchema> = {},
): ExpoSQLiteDatabase<TSchema> & {
	$client: SQLiteDatabase;
} {
	const dialect = new SQLiteSyncDialect({ 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 ExpoSQLiteSession(client, dialect, schema, { logger });
	const db = new ExpoSQLiteDatabase('sync', dialect, session, schema) as ExpoSQLiteDatabase<TSchema>;
	(<any> db).$client = client;

	return db as any;
}