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

driver-core.ts — drizzle-orm Source File

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

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

Entity Profile

Dependency Diagram

graph LR
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0["driver-core.ts"]
  71955c9c_98bb_2bea_3a87_96f5a4be3a27["session.ts"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> 71955c9c_98bb_2bea_3a87_96f5a4be3a27
  916e21cc_0bbc_927f_ecfb_2147725c35d9["LibSQLSession"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> 916e21cc_0bbc_927f_ecfb_2147725c35d9
  33707adf_3867_206c_1f47_142479def47f["client"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> 33707adf_3867_206c_1f47_142479def47f
  4dc3ba08_25aa_13fd_82c6_8802d5991d05["batch.ts"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> 4dc3ba08_25aa_13fd_82c6_8802d5991d05
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  3a0d0431_7555_f390_0d6a_8a596d3416a8["db.ts"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> 3a0d0431_7555_f390_0d6a_8a596d3416a8
  3d205d67_2ef4_984a_3241_ff4981527231["dialect.ts"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> 3d205d67_2ef4_984a_3241_ff4981527231
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  a9334ac2_693e_d2b0_7aa8_0e8c536982a0 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  31b4414e_8263_88ee_640d_ad9fb5a46759["driver.ts"]
  31b4414e_8263_88ee_640d_ad9fb5a46759 --> a9334ac2_693e_d2b0_7aa8_0e8c536982a0
  7fb64832_5ba6_5927_364e_7c47bd7b41f0["index.ts"]
  7fb64832_5ba6_5927_364e_7c47bd7b41f0 --> a9334ac2_693e_d2b0_7aa8_0e8c536982a0
  c48f608f_6ead_8a97_afb7_72a2931d53d5["index.ts"]
  c48f608f_6ead_8a97_afb7_72a2931d53d5 --> a9334ac2_693e_d2b0_7aa8_0e8c536982a0
  6bfdce1e_706e_579b_832f_32adb5a37a49["index.ts"]
  6bfdce1e_706e_579b_832f_32adb5a37a49 --> a9334ac2_693e_d2b0_7aa8_0e8c536982a0
  style a9334ac2_693e_d2b0_7aa8_0e8c536982a0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { Client, ResultSet } from '@libsql/client';
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 } from '~/utils.ts';
import { LibSQLSession } from './session.ts';

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

	/** @internal */
	declare readonly session: LibSQLSession<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>>;
	}
}

/** @internal */
export function construct<
	TSchema extends Record<string, unknown> = Record<string, never>,
>(client: Client, config: DrizzleConfig<TSchema> = {}): LibSQLDatabase<TSchema> & {
	$client: Client;
} {
	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 LibSQLSession(client, dialect, schema, { logger, cache: config.cache }, undefined);
	const db = new LibSQLDatabase('async', dialect, session, schema) as LibSQLDatabase<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;
}

Domain

Subdomains

Functions

Classes

Dependencies

Frequently Asked Questions

What does driver-core.ts do?
driver-core.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, RelationalQuery subdomain.
What functions are defined in driver-core.ts?
driver-core.ts defines 1 function(s): construct.
What does driver-core.ts depend on?
driver-core.ts imports 10 module(s): LibSQLSession, batch.ts, client, db.ts, dialect.ts, entity.ts, logger.ts, relations.ts, and 2 more.
What files import driver-core.ts?
driver-core.ts is imported by 7 file(s): driver.ts, index.ts, index.ts, index.ts, index.ts, index.ts, index.ts.
Where is driver-core.ts in the architecture?
driver-core.ts is located at drizzle-orm/src/libsql/driver-core.ts (domain: DrizzleORM, subdomain: RelationalQuery, directory: drizzle-orm/src/libsql).

Analyze Your Own Codebase

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

Try Supermodel Free