driver.ts — drizzle-orm Source File

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

File typescript DrizzleORM DatabaseDrivers 9 imports 1 dependents 3 functions 1 classes

Entity Profile

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

Dependency Diagram

graph LR
  0f0ec9c4_1c93_fe87_a305_092d4756cbda["driver.ts"]
  72a101a5_a087_5795_1ea2_26f9e19eeff9["session.ts"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda --> 72a101a5_a087_5795_1ea2_26f9e19eeff9
  1053eb6c_20a0_7889_a53b_cfa06854e18b["PostgresJsSession"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda --> 1053eb6c_20a0_7889_a53b_cfa06854e18b
  07445d0e_3235_2bb0_78cf_fa72a47ceb7f["postgres"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda --> 07445d0e_3235_2bb0_78cf_fa72a47ceb7f
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda --> 220c512d_350b_24bf_2142_53ec35a980ac
  84b656ff_244f_df0f_a4a0_653292f28349["db.ts"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda --> 84b656ff_244f_df0f_a4a0_653292f28349
  65dc222f_bc11_439f_d65b_20d7052b24ec["dialect.ts"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda --> 65dc222f_bc11_439f_d65b_20d7052b24ec
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  0f0ec9c4_1c93_fe87_a305_092d4756cbda --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  e9ef704a_94d2_fa38_eb96_a906671c8618["migrator.ts"]
  e9ef704a_94d2_fa38_eb96_a906671c8618 --> 0f0ec9c4_1c93_fe87_a305_092d4756cbda
  style 0f0ec9c4_1c93_fe87_a305_092d4756cbda fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import pgClient, { type Options, type PostgresType, type Sql } from 'postgres';
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, isConfig } from '~/utils.ts';
import type { PostgresJsQueryResultHKT } from './session.ts';
import { PostgresJsSession } from './session.ts';

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

function construct<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: Sql,
	config: DrizzleConfig<TSchema> = {},
): PostgresJsDatabase<TSchema> & {
	$client: Sql;
} {
	const transparentParser = (val: any) => val;

	// Override postgres.js default date parsers: https://github.com/porsager/postgres/discussions/761
	for (const type of ['1184', '1082', '1083', '1114', '1182', '1185', '1115', '1231']) {
		client.options.parsers[type as any] = transparentParser;
		client.options.serializers[type as any] = transparentParser;
	}
	client.options.serializers['114'] = transparentParser;
	client.options.serializers['3802'] = transparentParser;

	const dialect = new PgDialect({ 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 PostgresJsSession(client, dialect, schema, { logger, cache: config.cache });
	const db = new PostgresJsDatabase(dialect, session, schema as any) as PostgresJsDatabase<TSchema>;
// ... (74 more lines)

Domain

DrizzleORM

Subdomains

DatabaseDrivers

Functions

Classes

PostgresJsDatabase

Dependencies

PostgresJsSession
db.ts
dialect.ts
entity.ts
logger.ts
postgres
relations.ts
session.ts
utils.ts

Imported By

drizzle-orm/src/postgres-js/migrator.ts

Source

View on GitHub

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 9 module(s): PostgresJsSession, db.ts, dialect.ts, entity.ts, logger.ts, postgres, relations.ts, session.ts, and 1 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/postgres-js/driver.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/postgres-js).

Analyze Your Own Codebase

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

Try Supermodel Free