constructor() — drizzle-orm Function Reference

Architecture documentation for the constructor() function in foreign-keys.ts from the drizzle-orm codebase.

Function typescript DrizzleORM SQLDialects calls 1 called by 1

Entity Profile

DrizzleORM→ SQLDialects→ constructor() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  14b75bec_c6d2_112a_fdd2_de9418de1303["constructor()"]
  46597bc3_9b07_1c82_2d4e_eaf86f61d36f["ForeignKeyBuilder"]
  14b75bec_c6d2_112a_fdd2_de9418de1303 -->|defined in| 46597bc3_9b07_1c82_2d4e_eaf86f61d36f
  f63b391f_211d_298e_7bc0_f1fa6375af56["constructor()"]
  f63b391f_211d_298e_7bc0_f1fa6375af56 -->|calls| 14b75bec_c6d2_112a_fdd2_de9418de1303
  f63b391f_211d_298e_7bc0_f1fa6375af56["constructor()"]
  14b75bec_c6d2_112a_fdd2_de9418de1303 -->|calls| f63b391f_211d_298e_7bc0_f1fa6375af56
  style 14b75bec_c6d2_112a_fdd2_de9418de1303 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/foreign-keys.ts lines 27–46

	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;
		}
	}