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 3 functions 2 classes

Entity Profile

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

Dependency Diagram

graph LR
  53702de1_49d7_f27f_696b_4103d414417d["driver.ts"]
  f04e535e_b661_b4ac_5837_80cbf4e6ecba["session.ts"]
  53702de1_49d7_f27f_696b_4103d414417d --> f04e535e_b661_b4ac_5837_80cbf4e6ecba
  f7a3a747_96d4_b9ca_d4cb_e28899a93b1c["PgliteSession"]
  53702de1_49d7_f27f_696b_4103d414417d --> f7a3a747_96d4_b9ca_d4cb_e28899a93b1c
  cbab40d4_ac7c_1d5b_bd7b_7bf6059aeaf6["pglite"]
  53702de1_49d7_f27f_696b_4103d414417d --> cbab40d4_ac7c_1d5b_bd7b_7bf6059aeaf6
  4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4["cache.ts"]
  53702de1_49d7_f27f_696b_4103d414417d --> 4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  53702de1_49d7_f27f_696b_4103d414417d --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  53702de1_49d7_f27f_696b_4103d414417d --> 220c512d_350b_24bf_2142_53ec35a980ac
  84b656ff_244f_df0f_a4a0_653292f28349["db.ts"]
  53702de1_49d7_f27f_696b_4103d414417d --> 84b656ff_244f_df0f_a4a0_653292f28349
  65dc222f_bc11_439f_d65b_20d7052b24ec["dialect.ts"]
  53702de1_49d7_f27f_696b_4103d414417d --> 65dc222f_bc11_439f_d65b_20d7052b24ec
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  53702de1_49d7_f27f_696b_4103d414417d --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  53702de1_49d7_f27f_696b_4103d414417d --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  2777877d_9718_327a_8910_0c20806e1bc4["migrator.ts"]
  2777877d_9718_327a_8910_0c20806e1bc4 --> 53702de1_49d7_f27f_696b_4103d414417d
  style 53702de1_49d7_f27f_696b_4103d414417d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { PGlite, type PGliteOptions } from '@electric-sql/pglite';
import type { Cache } from '~/cache/core/cache.ts';
import { entityKind } from '~/entity.ts';
import type { Logger } from '~/logger.ts';
import { DefaultLogger } from '~/logger.ts';
import { PgDatabase } from '~/pg-core/db.ts';
import { PgDialect } from '~/pg-core/dialect.ts';
import {
	createTableRelationsHelpers,
	extractTablesRelationalConfig,
	type RelationalSchemaConfig,
	type TablesRelationalConfig,
} from '~/relations.ts';
import { type DrizzleConfig, isConfig } from '~/utils.ts';
import type { PgliteClient, PgliteQueryResultHKT } from './session.ts';
import { PgliteSession } from './session.ts';

export interface PgDriverOptions {
	logger?: Logger;
	cache?: Cache;
}

export class PgliteDriver {
	static readonly [entityKind]: string = 'PgliteDriver';

	constructor(
		private client: PgliteClient,
		private dialect: PgDialect,
		private options: PgDriverOptions = {},
	) {
	}

	createSession(
		schema: RelationalSchemaConfig<TablesRelationalConfig> | undefined,
	): PgliteSession<Record<string, unknown>, TablesRelationalConfig> {
		return new PgliteSession(this.client, this.dialect, schema, {
			logger: this.options.logger,
			cache: this.options.cache,
		});
	}
}

export class PgliteDatabase<
	TSchema extends Record<string, unknown> = Record<string, never>,
> extends PgDatabase<PgliteQueryResultHKT, TSchema> {
	static override readonly [entityKind]: string = 'PgliteDatabase';
}

function construct<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: PgliteClient,
	config: DrizzleConfig<TSchema> = {},
): PgliteDatabase<TSchema> & {
	$client: PgliteClient;
} {
	const dialect = new PgDialect({ casing: config.casing });
	let logger;
	if (config.logger === true) {
		logger = new DefaultLogger();
	} else if (config.logger !== false) {
		logger = config.logger;
// ... (102 more lines)