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
  ade454a0_abf8_c234_ac4a_1a7e60fde376["driver.ts"]
  a33b9761_e026_5d23_a559_f5bba879c2dd["session.ts"]
  ade454a0_abf8_c234_ac4a_1a7e60fde376 --> a33b9761_e026_5d23_a559_f5bba879c2dd
  02d0c510_ed76_17a4_347a_0a7ad3ef5c35["SQLiteBunSession"]
  ade454a0_abf8_c234_ac4a_1a7e60fde376 --> 02d0c510_ed76_17a4_347a_0a7ad3ef5c35
  8925695b_3773_48b7_06d1_2b60c9ed1057["bun:sqlite"]
  ade454a0_abf8_c234_ac4a_1a7e60fde376 --> 8925695b_3773_48b7_06d1_2b60c9ed1057
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  ade454a0_abf8_c234_ac4a_1a7e60fde376 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  ade454a0_abf8_c234_ac4a_1a7e60fde376 --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  ade454a0_abf8_c234_ac4a_1a7e60fde376 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  3a0d0431_7555_f390_0d6a_8a596d3416a8["db.ts"]
  ade454a0_abf8_c234_ac4a_1a7e60fde376 --> 3a0d0431_7555_f390_0d6a_8a596d3416a8
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  ade454a0_abf8_c234_ac4a_1a7e60fde376 --> 3d205d67_2ef4_984a_3241_ff4981527231
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  ade454a0_abf8_c234_ac4a_1a7e60fde376 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  471c218d_52dc_3839_a5ef_42a6c4cd9cf4["migrator.ts"]
  471c218d_52dc_3839_a5ef_42a6c4cd9cf4 --> ade454a0_abf8_c234_ac4a_1a7e60fde376
  style ade454a0_abf8_c234_ac4a_1a7e60fde376 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

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

import { Database } from 'bun: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, isConfig } from '~/utils.ts';
import { SQLiteBunSession } from './session.ts';

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

type DrizzleBunSqliteDatabaseOptions = {
	/**
	 * Open the database as read-only (no write operations, no create).
	 *
	 * Equivalent to {@link constants.SQLITE_OPEN_READONLY}
	 */
	readonly?: boolean;
	/**
	 * Allow creating a new database
	 *
	 * Equivalent to {@link constants.SQLITE_OPEN_CREATE}
	 */
	create?: boolean;
	/**
	 * Open the database as read-write
	 *
	 * Equivalent to {@link constants.SQLITE_OPEN_READWRITE}
	 */
	readwrite?: boolean;
};

export type DrizzleBunSqliteDatabaseConfig =
	| ({
		source?: string;
	} & DrizzleBunSqliteDatabaseOptions)
	| string
	| undefined;

function construct<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: Database,
	config: DrizzleConfig<TSchema> = {},
): BunSQLiteDatabase<TSchema> & {
	$client: Database;
} {
	const dialect = new SQLiteSyncDialect({ casing: config.casing });
	let logger;
	if (config.logger === true) {
		logger = new DefaultLogger();
// ... (94 more lines)