Home / File/ driver.ts — drizzle-orm Source File

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

Entity Profile

Dependency Diagram

graph LR
  04c2d726_fd72_4279_508e_4b3e799e7cea["driver.ts"]
  c22bad06_c896_0354_24e6_1e145c15794e["session.ts"]
  04c2d726_fd72_4279_508e_4b3e799e7cea --> c22bad06_c896_0354_24e6_1e145c15794e
  ec4b43ae_1b96_d924_e3b3_108b18fb2a90["SQLiteDOSession"]
  04c2d726_fd72_4279_508e_4b3e799e7cea --> ec4b43ae_1b96_d924_e3b3_108b18fb2a90
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  04c2d726_fd72_4279_508e_4b3e799e7cea --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  04c2d726_fd72_4279_508e_4b3e799e7cea --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  04c2d726_fd72_4279_508e_4b3e799e7cea --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  3a0d0431_7555_f390_0d6a_8a596d3416a8["db.ts"]
  04c2d726_fd72_4279_508e_4b3e799e7cea --> 3a0d0431_7555_f390_0d6a_8a596d3416a8
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  04c2d726_fd72_4279_508e_4b3e799e7cea --> 3d205d67_2ef4_984a_3241_ff4981527231
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  04c2d726_fd72_4279_508e_4b3e799e7cea --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  9968bfac_85c0_4a20_fc14_94b2593d793b["migrator.ts"]
  9968bfac_85c0_4a20_fc14_94b2593d793b --> 04c2d726_fd72_4279_508e_4b3e799e7cea
  style 04c2d726_fd72_4279_508e_4b3e799e7cea fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

/// <reference types="@cloudflare/workers-types" />
import { entityKind } from '~/entity.ts';
import { DefaultLogger } from '~/logger.ts';
import {
	createTableRelationsHelpers,
	extractTablesRelationalConfig,
	type ExtractTablesWithRelations,
	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 { SQLiteDOSession } from './session.ts';

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

	/** @internal */
	declare readonly session: SQLiteDOSession<TSchema, ExtractTablesWithRelations<TSchema>>;
}

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

	return db as any;
}

Domain

Subdomains

Functions

Dependencies

Frequently Asked Questions

What does driver.ts do?
driver.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, SQLDialects subdomain.
What functions are defined in driver.ts?
driver.ts defines 1 function(s): drizzle.
What does driver.ts depend on?
driver.ts imports 8 module(s): SQLiteDOSession, db.ts, dialect.ts, entity.ts, logger.ts, relations.ts, session.ts, utils.ts.
What files import driver.ts?
driver.ts is imported by 1 file(s): migrator.ts.
Where is driver.ts in the architecture?
driver.ts is located at drizzle-orm/src/durable-sqlite/driver.ts (domain: DrizzleORM, subdomain: SQLDialects, directory: drizzle-orm/src/durable-sqlite).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free