driver.ts — drizzle-orm Source File

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

File typescript DrizzleORM RelationalQuery 10 imports 1 dependents 1 functions 1 classes

Entity Profile

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

Dependency Diagram

graph LR
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d["driver.ts"]
  74ae4fc7_01d3_a587_15aa_476edeee51c0["session.ts"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> 74ae4fc7_01d3_a587_15aa_476edeee51c0
  45d8647d_c3c0_0e16_e569_86be8b7dc7ff["SQLiteD1Session"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> 45d8647d_c3c0_0e16_e569_86be8b7dc7ff
  a747a5eb_af84_a763_85ed_2a94aae8816c["d1"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> a747a5eb_af84_a763_85ed_2a94aae8816c
  4dc3ba08_25aa_13fd_82c6_8802d5991d05["batch.ts"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> 4dc3ba08_25aa_13fd_82c6_8802d5991d05
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  3a0d0431_7555_f390_0d6a_8a596d3416a8["db.ts"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> 3a0d0431_7555_f390_0d6a_8a596d3416a8
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> 3d205d67_2ef4_984a_3241_ff4981527231
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  89e1a0a3_2876_d680_cdf6_8f2b181caa6d --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  2a844237_8d8e_95f7_04ad_b2253da28464["migrator.ts"]
  2a844237_8d8e_95f7_04ad_b2253da28464 --> 89e1a0a3_2876_d680_cdf6_8f2b181caa6d
  style 89e1a0a3_2876_d680_cdf6_8f2b181caa6d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

/// <reference types="@cloudflare/workers-types" />
import type { D1Database as MiniflareD1Database } from '@miniflare/d1';
import type { BatchItem, BatchResponse } from '~/batch.ts';
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 { SQLiteAsyncDialect } from '~/sqlite-core/dialect.ts';
import type { DrizzleConfig, IfNotImported } from '~/utils.ts';
import { SQLiteD1Session } from './session.ts';

export type AnyD1Database = IfNotImported<
	D1Database,
	MiniflareD1Database,
	D1Database | IfNotImported<MiniflareD1Database, never, MiniflareD1Database>
>;

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

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

	async batch<U extends BatchItem<'sqlite'>, T extends Readonly<[U, ...U[]]>>(
		batch: T,
	): Promise<BatchResponse<T>> {
		return this.session.batch(batch) as Promise<BatchResponse<T>>;
	}
}

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