drizzle-orm Architecture Docs
Home / File/ foreign-keys.ts — drizzle-orm Source File

foreign-keys.ts — drizzle-orm Source File

Architecture documentation for foreign-keys.ts, a typescript file in the drizzle-orm codebase. 4 imports, 2 dependents.

File typescript DrizzleORM SQLDialects 4 imports 2 dependents 2 functions 2 classes

Entity Profile

Dependency Diagram

graph LR
  5ab311c5_4977_231c_634b_5190e6ed4054["foreign-keys.ts"]
  e383fa18_3db6_3f2c_0ac0_30b5ced54ad6["index.ts"]
  5ab311c5_4977_231c_634b_5190e6ed4054 --> e383fa18_3db6_3f2c_0ac0_30b5ced54ad6
  62c695d3_7eff_3822_db70_ce6b25ccdb04["table.ts"]
  5ab311c5_4977_231c_634b_5190e6ed4054 --> 62c695d3_7eff_3822_db70_ce6b25ccdb04
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  5ab311c5_4977_231c_634b_5190e6ed4054 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  05fb227e_0b02_2bf4_175f_8e70216a34a7["table.utils.ts"]
  5ab311c5_4977_231c_634b_5190e6ed4054 --> 05fb227e_0b02_2bf4_175f_8e70216a34a7
  62c695d3_7eff_3822_db70_ce6b25ccdb04["table.ts"]
  62c695d3_7eff_3822_db70_ce6b25ccdb04 --> 5ab311c5_4977_231c_634b_5190e6ed4054
  af63b8b3_1221_118f_75ac_f0b56c078499["utils.ts"]
  af63b8b3_1221_118f_75ac_f0b56c078499 --> 5ab311c5_4977_231c_634b_5190e6ed4054
  style 5ab311c5_4977_231c_634b_5190e6ed4054 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind } from '~/entity.ts';
import { TableName } from '~/table.utils.ts';
import type { AnyMySqlColumn, MySqlColumn } from './columns/index.ts';
import type { MySqlTable } from './table.ts';

export type UpdateDeleteAction = 'cascade' | 'restrict' | 'no action' | 'set null' | 'set default';

export type Reference = () => {
	readonly name?: string;
	readonly columns: MySqlColumn[];
	readonly foreignTable: MySqlTable;
	readonly foreignColumns: MySqlColumn[];
};

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

	/** @internal */
	reference: Reference;

	/** @internal */
	_onUpdate: UpdateDeleteAction | undefined;

	/** @internal */
	_onDelete: UpdateDeleteAction | undefined;

	constructor(
		config: () => {
			name?: string;
			columns: MySqlColumn[];
			foreignColumns: MySqlColumn[];
		},
		actions?: {
			onUpdate?: UpdateDeleteAction;
			onDelete?: UpdateDeleteAction;
		} | undefined,
	) {
		this.reference = () => {
			const { name, columns, foreignColumns } = config();
			return { name, columns, foreignTable: foreignColumns[0]!.table as MySqlTable, foreignColumns };
		};
		if (actions) {
			this._onUpdate = actions.onUpdate;
			this._onDelete = actions.onDelete;
		}
	}

	onUpdate(action: UpdateDeleteAction): this {
		this._onUpdate = action;
		return this;
	}

	onDelete(action: UpdateDeleteAction): this {
		this._onDelete = action;
		return this;
	}

	/** @internal */
	build(table: MySqlTable): ForeignKey {
		return new ForeignKey(table, this);
// ... (67 more lines)

Domain

Subdomains

Functions

Classes

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does foreign-keys.ts do?
foreign-keys.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 foreign-keys.ts?
foreign-keys.ts defines 2 function(s): MySqlColumn, foreignKey.
What does foreign-keys.ts depend on?
foreign-keys.ts imports 4 module(s): entity.ts, index.ts, table.ts, table.utils.ts.
What files import foreign-keys.ts?
foreign-keys.ts is imported by 2 file(s): table.ts, utils.ts.
Where is foreign-keys.ts in the architecture?
foreign-keys.ts is located at drizzle-orm/src/mysql-core/foreign-keys.ts (domain: DrizzleORM, subdomain: SQLDialects, directory: drizzle-orm/src/mysql-core).

Analyze Your Own Codebase

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

Try Supermodel Free