db.ts — drizzle-orm Source File

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

File typescript DrizzleORM SQLDialects 20 imports 1 dependents 1 functions 1 classes

Entity Profile

DrizzleORM→ SQLDialects→ db.ts — drizzle-orm Source File

Dependency Diagram

graph LR
  55a32696_6538_e52d_9dd2_18695934fe32["db.ts"]
  8f4067ff_24d4_558a_f9a8_8c5b4d708ae5["dialect.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> 8f4067ff_24d4_558a_f9a8_8c5b4d708ae5
  eee8ef5a_a55a_1296_0eb0_8b784d2ecf58["count.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> eee8ef5a_a55a_1296_0eb0_8b784d2ecf58
  7ca41881_9524_bd95_d93b_aa44d5e89fa7["MySqlCountBuilder"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> 7ca41881_9524_bd95_d93b_aa44d5e89fa7
  94fe43a6_d421_3d58_5028_bac2c0fcec01["index.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> 94fe43a6_d421_3d58_5028_bac2c0fcec01
  c0f473e5_fef0_c6f5_7c3f_5af2802f3012["query.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> c0f473e5_fef0_c6f5_7c3f_5af2802f3012
  ac00866c_8363_7776_139c_2ecce82899f9["RelationalQueryBuilder"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> ac00866c_8363_7776_139c_2ecce82899f9
  b145d7b0_f119_a29a_6da7_7ad4e74e20fa["select.types.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> b145d7b0_f119_a29a_6da7_7ad4e74e20fa
  e8dc183d_ef37_2b6f_dec4_127a8dea0aaf["session.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> e8dc183d_ef37_2b6f_dec4_127a8dea0aaf
  41e24ea2_64c2_84e2_5326_1adea37e5359["subquery.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> 41e24ea2_64c2_84e2_5326_1adea37e5359
  62c695d3_7eff_3822_db70_ce6b25ccdb04["table.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> 62c695d3_7eff_3822_db70_ce6b25ccdb04
  a79cf58d_7307_4b51_46d7_0b6063316314["view-base.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> a79cf58d_7307_4b51_46d7_0b6063316314
  a340f455_7575_91f4_791a_10cd9b9dba1a["promise"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> a340f455_7575_91f4_791a_10cd9b9dba1a
  4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4["cache.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> 4509cca4_7fd9_2ecd_1b7c_1ef1c0ee30c4
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  55a32696_6538_e52d_9dd2_18695934fe32 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  style 55a32696_6538_e52d_9dd2_18695934fe32 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { ResultSetHeader } from 'mysql2/promise';
import type { Cache } from '~/cache/core/cache.ts';
import { entityKind } from '~/entity.ts';
import type { TypedQueryBuilder } from '~/query-builders/query-builder.ts';
import type { ExtractTablesWithRelations, RelationalSchemaConfig, TablesRelationalConfig } from '~/relations.ts';
import { SelectionProxyHandler } from '~/selection-proxy.ts';
import { type ColumnsSelection, type SQL, sql, type SQLWrapper } from '~/sql/sql.ts';
import { WithSubquery } from '~/subquery.ts';
import type { DrizzleTypeError } from '~/utils.ts';
import type { MySqlDialect } from './dialect.ts';
import { MySqlCountBuilder } from './query-builders/count.ts';
import {
	MySqlDeleteBase,
	MySqlInsertBuilder,
	MySqlSelectBuilder,
	MySqlUpdateBuilder,
	QueryBuilder,
} from './query-builders/index.ts';
import { RelationalQueryBuilder } from './query-builders/query.ts';
import type { SelectedFields } from './query-builders/select.types.ts';
import type {
	Mode,
	MySqlQueryResultHKT,
	MySqlQueryResultKind,
	MySqlSession,
	MySqlTransaction,
	MySqlTransactionConfig,
	PreparedQueryHKTBase,
} from './session.ts';
import type { WithBuilder } from './subquery.ts';
import type { MySqlTable } from './table.ts';
import type { MySqlViewBase } from './view-base.ts';

export class MySqlDatabase<
	TQueryResult extends MySqlQueryResultHKT,
	TPreparedQueryHKT extends PreparedQueryHKTBase,
	TFullSchema extends Record<string, unknown> = {},
	TSchema extends TablesRelationalConfig = ExtractTablesWithRelations<TFullSchema>,
> {
	static readonly [entityKind]: string = 'MySqlDatabase';

	declare readonly _: {
		readonly schema: TSchema | undefined;
		readonly fullSchema: TFullSchema;
		readonly tableNamesMap: Record<string, string>;
	};

	query: TFullSchema extends Record<string, never>
		? DrizzleTypeError<'Seems like the schema generic is missing - did you forget to add it to your DB type?'>
		: {
			[K in keyof TSchema]: RelationalQueryBuilder<TPreparedQueryHKT, TSchema, TSchema[K]>;
		};

	constructor(
		/** @internal */
		readonly dialect: MySqlDialect,
		/** @internal */
		readonly session: MySqlSession<any, any, any, any>,
		schema: RelationalSchemaConfig<TSchema> | undefined,
		protected readonly mode: Mode,
// ... (478 more lines)