getName() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

graph TD
  848c0766_a0f7_a0c3_0f2e_e43969e37161["getName()"]
  e14e02a6_4273_1b91_e67d_8b5bbffd1bcc["ForeignKey"]
  848c0766_a0f7_a0c3_0f2e_e43969e37161 -->|defined in| e14e02a6_4273_1b91_e67d_8b5bbffd1bcc
  style 848c0766_a0f7_a0c3_0f2e_e43969e37161 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/sqlite-core/foreign-keys.ts lines 82–93

	getName(): string {
		const { name, columns, foreignColumns } = this.reference();
		const columnNames = columns.map((column) => column.name);
		const foreignColumnNames = foreignColumns.map((column) => column.name);
		const chunks = [
			this.table[TableName],
			...columnNames,
			foreignColumns[0]!.table[TableName],
			...foreignColumnNames,
		];
		return name ?? `${chunks.join('_')}_fk`;
	}