constructor() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers calls 1 called by 1

Entity Profile

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

Dependency Diagram

graph TD
  3b021b57_6253_fdf3_54bd_b40fd4fe2618["constructor()"]
  958f881b_7907_5e7e_0e91_d68d49a8af1b["ForeignKeyBuilder"]
  3b021b57_6253_fdf3_54bd_b40fd4fe2618 -->|defined in| 958f881b_7907_5e7e_0e91_d68d49a8af1b
  82db7e08_d004_c00e_a210_0b7eccc5ffe4["constructor()"]
  82db7e08_d004_c00e_a210_0b7eccc5ffe4 -->|calls| 3b021b57_6253_fdf3_54bd_b40fd4fe2618
  82db7e08_d004_c00e_a210_0b7eccc5ffe4["constructor()"]
  3b021b57_6253_fdf3_54bd_b40fd4fe2618 -->|calls| 82db7e08_d004_c00e_a210_0b7eccc5ffe4
  style 3b021b57_6253_fdf3_54bd_b40fd4fe2618 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

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

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