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 QueryBuilders 9 imports 1 dependents 1 functions 2 classes

Entity Profile

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

Dependency Diagram

graph LR
  873bd06d_d5ad_ee33_9029_a6593dd73ae2["driver.ts"]
  dc9eb55a_1416_8b51_1561_0f80fbda9f7f["session.ts"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2 --> dc9eb55a_1416_8b51_1561_0f80fbda9f7f
  c5129061_5764_d876_3e0b_d0817994976c["XataHttpSession"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2 --> c5129061_5764_d876_3e0b_d0817994976c
  4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4["cache.ts"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2 --> 4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  220c512d_350b_24bf_2142_53ec35a980ac["logger.ts"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2 --> 220c512d_350b_24bf_2142_53ec35a980ac
  84b656ff_244f_df0f_a4a0_653292f28349["db.ts"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2 --> 84b656ff_244f_df0f_a4a0_653292f28349
  65dc222f_bc11_439f_d65b_20d7052b24ec["dialect.ts"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2 --> 65dc222f_bc11_439f_d65b_20d7052b24ec
  e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2["relations.ts"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2 --> e4d6a0ab_9aa2_13a6_a2f1_58d94314c3f2
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  873bd06d_d5ad_ee33_9029_a6593dd73ae2 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  6fd7cb0a_8ff7_94fe_5fa1_18f4acd5f695["migrator.ts"]
  6fd7cb0a_8ff7_94fe_5fa1_18f4acd5f695 --> 873bd06d_d5ad_ee33_9029_a6593dd73ae2
  style 873bd06d_d5ad_ee33_9029_a6593dd73ae2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

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 type { ExtractTablesWithRelations, RelationalSchemaConfig, TablesRelationalConfig } from '~/relations.ts';
import { createTableRelationsHelpers, extractTablesRelationalConfig } from '~/relations.ts';
import type { DrizzleConfig } from '~/utils.ts';
import type { XataHttpClient, XataHttpQueryResultHKT } from './session.ts';
import { XataHttpSession } from './session.ts';

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

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

	constructor(
		private client: XataHttpClient,
		private dialect: PgDialect,
		private options: XataDriverOptions = {},
	) {
		this.initMappers();
	}

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

	initMappers() {
		// TODO: Add custom type parsers
	}
}

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

	/** @internal */
	declare readonly session: XataHttpSession<TSchema, ExtractTablesWithRelations<TSchema>>;
}

export function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
	client: XataHttpClient,
	config: DrizzleConfig<TSchema> = {},
): XataHttpDatabase<TSchema> & {
	$client: XataHttpClient;
} {
	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 driver = new XataHttpDriver(client, dialect, { logger, cache: config.cache });
	const session = driver.createSession(schema);

	const db = new XataHttpDatabase(
		dialect,
		session,
		schema as RelationalSchemaConfig<ExtractTablesWithRelations<TSchema>> | undefined,
	);
	(<any> db).$client = client;
	(<any> db).$cache = config.cache;
	if ((<any> db).$cache) {
		(<any> db).$cache['invalidate'] = config.cache?.onMutate;
	}

	return db as any;
}