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. 10 imports, 1 dependents.

File typescript DrizzleORM DatabaseDrivers 10 imports 1 dependents 3 functions 2 classes

Entity Profile

Dependency Diagram

graph LR
  e62c4bff_79fa_8bf4_2716_485f05b01506["driver.ts"]
  0507ccca_3cb1_384d_6315_fc19900c69b1["session.ts"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> 0507ccca_3cb1_384d_6315_fc19900c69b1
  c379869d_eae7_28c1_b5ff_21c36a0fef11["NodePgSession"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> c379869d_eae7_28c1_b5ff_21c36a0fef11
  0d277acf_0d68_9daf_8724_642232a89719["pg"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> 0d277acf_0d68_9daf_8724_642232a89719
  4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4["cache.ts"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> 4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> 220c512d_350b_24bf_2142_53ec35a980ac
  84b656ff_244f_df0f_a4a0_653292f28349["db.ts"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> 84b656ff_244f_df0f_a4a0_653292f28349
  65dc222f_bc11_439f_d65b_20d7052b24ec["dialect.ts"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> 65dc222f_bc11_439f_d65b_20d7052b24ec
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  e62c4bff_79fa_8bf4_2716_485f05b01506 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  79b7744e_cd60_beff_1893_365cc454b4a2["migrator.ts"]
  79b7744e_cd60_beff_1893_365cc454b4a2 --> e62c4bff_79fa_8bf4_2716_485f05b01506
  style e62c4bff_79fa_8bf4_2716_485f05b01506 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import pg, { type Pool, type PoolConfig } from 'pg';
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 { NodePgClient, NodePgQueryResultHKT } from './session.ts';
import { NodePgSession } from './session.ts';

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

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

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

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

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

function construct<
	TSchema extends Record<string, unknown> = Record<string, never>,
	TClient extends NodePgClient = NodePgClient,
>(
	client: TClient,
	config: DrizzleConfig<TSchema> = {},
): NodePgDatabase<TSchema> & {
	$client: NodePgClient extends TClient ? Pool : TClient;
} {
	const dialect = new PgDialect({ casing: config.casing });
	let logger;
	if (config.logger === true) {
// ... (91 more lines)

Domain

Subdomains

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, DatabaseDrivers subdomain.
What functions are defined in driver.ts?
driver.ts defines 3 function(s): construct, drizzle, mock.
What does driver.ts depend on?
driver.ts imports 10 module(s): NodePgSession, cache.ts, db.ts, dialect.ts, entity.ts, logger.ts, pg, relations.ts, and 2 more.
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/node-postgres/driver.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/node-postgres).

Analyze Your Own Codebase

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

Try Supermodel Free