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

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

Entity Profile

Dependency Diagram

graph LR
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd["driver.ts"]
  e55f93a1_bb42_b29e_7f05_390a87b09427["session.ts"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd --> e55f93a1_bb42_b29e_7f05_390a87b09427
  432fe997_4ba4_3b24_2264_ddd303ea4f59["PlanetscaleSession"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd --> 432fe997_4ba4_3b24_2264_ddd303ea4f59
  42a10794_e73a_91c6_c755_ae09e500977e["database"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd --> 42a10794_e73a_91c6_c755_ae09e500977e
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd --> 220c512d_350b_24bf_2142_53ec35a980ac
  cffd352b_ee7e_3520_6232_dcb292268798["db.ts"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd --> cffd352b_ee7e_3520_6232_dcb292268798
  8e1e9852_05bf_563a_0455_d59c9d25a84e["dialect.ts"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd --> 8e1e9852_05bf_563a_0455_d59c9d25a84e
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  b80e0b43_b72d_90f7_a9b9_73f6d40500bd --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  0b7b7bce_5997_3526_337c_899ad430a0cd["migrator.ts"]
  0b7b7bce_5997_3526_337c_899ad430a0cd --> b80e0b43_b72d_90f7_a9b9_73f6d40500bd
  style b80e0b43_b72d_90f7_a9b9_73f6d40500bd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { Config } from '@planetscale/database';
import { Client } from '@planetscale/database';
import { entityKind } from '~/entity.ts';
import type { Logger } from '~/logger.ts';
import { DefaultLogger } from '~/logger.ts';
import { MySqlDatabase } from '~/mysql-core/db.ts';
import { MySqlDialect } from '~/mysql-core/dialect.ts';
import {
	createTableRelationsHelpers,
	extractTablesRelationalConfig,
	type RelationalSchemaConfig,
	type TablesRelationalConfig,
} from '~/relations.ts';
import { type DrizzleConfig, isConfig } from '~/utils.ts';
import type { PlanetScalePreparedQueryHKT, PlanetscaleQueryResultHKT } from './session.ts';
import { PlanetscaleSession } from './session.ts';

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

export class PlanetScaleDatabase<
	TSchema extends Record<string, unknown> = Record<string, never>,
> extends MySqlDatabase<PlanetscaleQueryResultHKT, PlanetScalePreparedQueryHKT, TSchema> {
	static override readonly [entityKind]: string = 'PlanetScaleDatabase';
}

function construct<
	TSchema extends Record<string, unknown> = Record<string, never>,
	TClient extends Client = Client,
>(
	client: TClient,
	config: DrizzleConfig<TSchema> = {},
): PlanetScaleDatabase<TSchema> & {
	$client: TClient;
} {
	// Client is not Drizzle Object, so we can ignore this rule here
	// eslint-disable-next-line no-instanceof/no-instanceof
	if (!(client instanceof Client)) {
		throw new Error(`Warning: You need to pass an instance of Client:

import { Client } from "@planetscale/database";

const client = new Client({
  host: process.env["DATABASE_HOST"],
  username: process.env["DATABASE_USERNAME"],
  password: process.env["DATABASE_PASSWORD"],
});

const db = drizzle(client);
		`);
	}

	const dialect = new MySqlDialect({ casing: config.casing });
	let logger;
	if (config.logger === true) {
		logger = new DefaultLogger();
	} else if (config.logger !== false) {
		logger = config.logger;
// ... (87 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, RelationalQuery 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): PlanetscaleSession, database, db.ts, dialect.ts, entity.ts, logger.ts, 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/planetscale-serverless/driver.ts (domain: DrizzleORM, subdomain: RelationalQuery, directory: drizzle-orm/src/planetscale-serverless).

Analyze Your Own Codebase

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

Try Supermodel Free