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. 8 imports, 2 dependents.

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

Entity Profile

Dependency Diagram

graph LR
  1586d097_c2d5_bc55_4474_4f081ee3dd3e["driver.ts"]
  41dec58c_4b3d_714e_c573_122447f23c5a["session.ts"]
  1586d097_c2d5_bc55_4474_4f081ee3dd3e --> 41dec58c_4b3d_714e_c573_122447f23c5a
  727d44ea_818d_2a16_7d69_b20d7db81f64["SingleStoreRemoteSession"]
  1586d097_c2d5_bc55_4474_4f081ee3dd3e --> 727d44ea_818d_2a16_7d69_b20d7db81f64
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  1586d097_c2d5_bc55_4474_4f081ee3dd3e --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  1586d097_c2d5_bc55_4474_4f081ee3dd3e --> 220c512d_350b_24bf_2142_53ec35a980ac
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  1586d097_c2d5_bc55_4474_4f081ee3dd3e --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  464acff4_0949_be30_6c79_3d0b1523ba16["db.ts"]
  1586d097_c2d5_bc55_4474_4f081ee3dd3e --> 464acff4_0949_be30_6c79_3d0b1523ba16
  e0cf6f45_6d77_2e69_af64_53d1b57b73fe["dialect.ts"]
  1586d097_c2d5_bc55_4474_4f081ee3dd3e --> e0cf6f45_6d77_2e69_af64_53d1b57b73fe
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  1586d097_c2d5_bc55_4474_4f081ee3dd3e --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  27d8247e_8c81_1fdb_66cc_072963ce230b["migrator.ts"]
  27d8247e_8c81_1fdb_66cc_072963ce230b --> 1586d097_c2d5_bc55_4474_4f081ee3dd3e
  41dec58c_4b3d_714e_c573_122447f23c5a["session.ts"]
  41dec58c_4b3d_714e_c573_122447f23c5a --> 1586d097_c2d5_bc55_4474_4f081ee3dd3e
  style 1586d097_c2d5_bc55_4474_4f081ee3dd3e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind } from '~/entity.ts';
import { DefaultLogger } from '~/logger.ts';
import {
	createTableRelationsHelpers,
	extractTablesRelationalConfig,
	type RelationalSchemaConfig,
	type TablesRelationalConfig,
} from '~/relations.ts';
import { SingleStoreDatabase } from '~/singlestore-core/db.ts';
import { SingleStoreDialect } from '~/singlestore-core/dialect.ts';
import type { DrizzleConfig } from '~/utils.ts';
import {
	type SingleStoreRemotePreparedQueryHKT,
	type SingleStoreRemoteQueryResultHKT,
	SingleStoreRemoteSession,
} from './session.ts';

export class SingleStoreRemoteDatabase<
	TSchema extends Record<string, unknown> = Record<string, never>,
> extends SingleStoreDatabase<SingleStoreRemoteQueryResultHKT, SingleStoreRemotePreparedQueryHKT, TSchema> {
	static override readonly [entityKind]: string = 'SingleStoreRemoteDatabase';
}

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

export function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
	callback: RemoteCallback,
	config: DrizzleConfig<TSchema> = {},
): SingleStoreRemoteDatabase<TSchema> {
	const dialect = new SingleStoreDialect({ 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 SingleStoreRemoteSession(callback, dialect, schema, { logger });
	return new SingleStoreRemoteDatabase(dialect, session, schema as any) as SingleStoreRemoteDatabase<
		TSchema
	>;
}

Domain

Subdomains

Functions

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, SQLDialects subdomain.
What functions are defined in driver.ts?
driver.ts defines 2 function(s): drizzle, sql.
What does driver.ts depend on?
driver.ts imports 8 module(s): SingleStoreRemoteSession, db.ts, dialect.ts, entity.ts, logger.ts, relations.ts, session.ts, utils.ts.
What files import driver.ts?
driver.ts is imported by 2 file(s): migrator.ts, session.ts.
Where is driver.ts in the architecture?
driver.ts is located at drizzle-orm/src/singlestore-proxy/driver.ts (domain: DrizzleORM, subdomain: SQLDialects, directory: drizzle-orm/src/singlestore-proxy).

Analyze Your Own Codebase

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

Try Supermodel Free