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

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

Dependency Diagram

graph LR
  4900d433_b74f_ced2_6f6d_410f252d1ff8["driver.ts"]
  5332ec54_ebfc_a1f4_a95c_2a39ae467e61["session.ts"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> 5332ec54_ebfc_a1f4_a95c_2a39ae467e61
  81a4e159_1fd1_64d3_dcd4_a1fbabbc531f["VercelPgSession"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> 81a4e159_1fd1_64d3_dcd4_a1fbabbc531f
  74711ae3_e5be_1fb9_6f6b_6af95540b473["postgres"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> 74711ae3_e5be_1fb9_6f6b_6af95540b473
  4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4["cache.ts"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> 4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> 220c512d_350b_24bf_2142_53ec35a980ac
  84b656ff_244f_df0f_a4a0_653292f28349["db.ts"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> 84b656ff_244f_df0f_a4a0_653292f28349
  fa14e9c0_b73d_4bcb_463b_adf18df8a285["index.ts"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> fa14e9c0_b73d_4bcb_463b_adf18df8a285
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  4900d433_b74f_ced2_6f6d_410f252d1ff8 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  01b7af55_0bc6_4c5d_6c8f_d45f51a5f615["migrator.ts"]
  01b7af55_0bc6_4c5d_6c8f_d45f51a5f615 --> 4900d433_b74f_ced2_6f6d_410f252d1ff8
  style 4900d433_b74f_ced2_6f6d_410f252d1ff8 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { sql } from '@vercel/postgres';
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/index.ts';
import {
	createTableRelationsHelpers,
	extractTablesRelationalConfig,
	type RelationalSchemaConfig,
	type TablesRelationalConfig,
} from '~/relations.ts';
import { type DrizzleConfig, isConfig } from '~/utils.ts';
import { type VercelPgClient, type VercelPgQueryResultHKT, VercelPgSession } from './session.ts';

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

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

	constructor(
		private client: VercelPgClient,
		private dialect: PgDialect,
		private options: VercelPgDriverOptions = {},
	) {
	}

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

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

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

Domain

DrizzleORM

Subdomains

DatabaseDrivers

Functions

Classes

Types

VercelPgDriverOptions

Dependencies

VercelPgSession
cache.ts
db.ts
entity.ts
index.ts
logger.ts
postgres
relations.ts
session.ts
utils.ts

Imported By

drizzle-orm/src/vercel-postgres/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 10 module(s): VercelPgSession, cache.ts, db.ts, entity.ts, index.ts, logger.ts, postgres, 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/vercel-postgres/driver.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/vercel-postgres).

Analyze Your Own Codebase

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

Try Supermodel Free