driver.ts — drizzle-orm Source File

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

File typescript DrizzleORM SQLDialects 8 imports 1 dependents 1 functions

Entity Profile

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

Dependency Diagram

graph LR
  5f134997_2cad_bdb1_00ab_4ea928547b4e["driver.ts"]
  058d4164_8a6e_e307_11eb_23f5c52611d5["session.ts"]
  5f134997_2cad_bdb1_00ab_4ea928547b4e --> 058d4164_8a6e_e307_11eb_23f5c52611d5
  6e5968f3_3f01_5fbb_b14b_e64c88c7916a["SQLJsSession"]
  5f134997_2cad_bdb1_00ab_4ea928547b4e --> 6e5968f3_3f01_5fbb_b14b_e64c88c7916a
  e3b6939f_7479_645e_3a63_79763ad4c27c["sql.js"]
  5f134997_2cad_bdb1_00ab_4ea928547b4e --> e3b6939f_7479_645e_3a63_79763ad4c27c
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  5f134997_2cad_bdb1_00ab_4ea928547b4e --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  5f134997_2cad_bdb1_00ab_4ea928547b4e --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  3a0d0431_7555_f390_0d6a_8a596d3416a8["db.ts"]
  5f134997_2cad_bdb1_00ab_4ea928547b4e --> 3a0d0431_7555_f390_0d6a_8a596d3416a8
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  5f134997_2cad_bdb1_00ab_4ea928547b4e --> 3d205d67_2ef4_984a_3241_ff4981527231
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  5f134997_2cad_bdb1_00ab_4ea928547b4e --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  0eacf7e5_7c74_b720_aed3_53ef7135b39e["migrator.ts"]
  0eacf7e5_7c74_b720_aed3_53ef7135b39e --> 5f134997_2cad_bdb1_00ab_4ea928547b4e
  style 5f134997_2cad_bdb1_00ab_4ea928547b4e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { Database } from 'sql.js';
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 { SQLJsSession } from './session.ts';

export type SQLJsDatabase<
	TSchema extends Record<string, unknown> = Record<string, never>,
> = BaseSQLiteDatabase<'sync', void, TSchema>;

export function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: Database,
	config: DrizzleConfig<TSchema> = {},
): SQLJsDatabase<TSchema> {
	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 SQLJsSession(client, dialect, schema, { logger });
	return new BaseSQLiteDatabase('sync', dialect, session, schema) as SQLJsDatabase<TSchema>;
}