driver.ts — drizzle-orm Source File

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

File typescript DrizzleORM DatabaseDrivers 8 imports 2 dependents 2 functions 1 classes

Entity Profile

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

Dependency Diagram

graph LR
  ee7c7e23_fdff_7c96_7cae_c54f532826da["driver.ts"]
  f4189250_2b2a_26e0_5ac1_cf329ff59ed1["session.ts"]
  ee7c7e23_fdff_7c96_7cae_c54f532826da --> f4189250_2b2a_26e0_5ac1_cf329ff59ed1
  b69ac739_b472_4c04_b4cd_f3f8b7c47873["PgRemoteSession"]
  ee7c7e23_fdff_7c96_7cae_c54f532826da --> b69ac739_b472_4c04_b4cd_f3f8b7c47873
  9347c3af_060d_bd99_cd17_d7f17fadf7cb["entity.ts"]
  ee7c7e23_fdff_7c96_7cae_c54f532826da --> 9347c3af_060d_bd99_cd17_d7f17fadf7cb
  0847bcb9_09e4_7324_4f43_dfb250de02fc["logger.ts"]
  ee7c7e23_fdff_7c96_7cae_c54f532826da --> 0847bcb9_09e4_7324_4f43_dfb250de02fc
  1971d163_dd43_68ad_b49a_7e21d2f5d1ce["db.ts"]
  ee7c7e23_fdff_7c96_7cae_c54f532826da --> 1971d163_dd43_68ad_b49a_7e21d2f5d1ce
  15de0fd8_4ebe_c1dd_f9d8_4c2711730d6c["dialect.ts"]
  ee7c7e23_fdff_7c96_7cae_c54f532826da --> 15de0fd8_4ebe_c1dd_f9d8_4c2711730d6c
  3a0d6283_b08d_f0ff_8c5a_dd41d7ac83d0["relations.ts"]
  ee7c7e23_fdff_7c96_7cae_c54f532826da --> 3a0d6283_b08d_f0ff_8c5a_dd41d7ac83d0
  75901f99_b0fe_057b_6268_cf00202bd6f8["utils.ts"]
  ee7c7e23_fdff_7c96_7cae_c54f532826da --> 75901f99_b0fe_057b_6268_cf00202bd6f8
  4a8fecfc_cbfb_b2a8_0dbe_b919222d006b["migrator.ts"]
  4a8fecfc_cbfb_b2a8_0dbe_b919222d006b --> ee7c7e23_fdff_7c96_7cae_c54f532826da
  f4189250_2b2a_26e0_5ac1_cf329ff59ed1["session.ts"]
  f4189250_2b2a_26e0_5ac1_cf329ff59ed1 --> ee7c7e23_fdff_7c96_7cae_c54f532826da
  style ee7c7e23_fdff_7c96_7cae_c54f532826da fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind } from '~/entity.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 } from '~/utils.ts';
import { type PgRemoteQueryResultHKT, PgRemoteSession } from './session.ts';

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

export type RemoteCallback = (
	sql: string,
	params: any[],
	method: 'all' | 'execute',
	typings?: any[],
) => Promise<{ rows: any[] }>;

export function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
	callback: RemoteCallback,
	config: DrizzleConfig<TSchema> = {},
	_dialect: () => PgDialect = () => new PgDialect({ casing: config.casing }),
): PgRemoteDatabase<TSchema> {
	const dialect = _dialect();
	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 PgRemoteSession(callback, dialect, schema, { logger, cache: config.cache });
	const db = new PgRemoteDatabase(dialect, session, schema as any) as PgRemoteDatabase<TSchema>;
	(<any> db).$cache = config.cache;
	if ((<any> db).$cache) {
		(<any> db).$cache['invalidate'] = config.cache?.onMutate;
	}

	return db;
}