withFieldName() — drizzle-orm Function Reference

Architecture documentation for the withFieldName() function in relations.ts from the drizzle-orm codebase.

Function typescript DrizzleORM RelationalQuery calls 1 called by 1

Entity Profile

DrizzleORM→ RelationalQuery→ withFieldName() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  0ab4b259_5711_27c1_0ec7_58b25e6df3b8["withFieldName()"]
  776c65da_a3c4_5133_217d_969e536f67b3["Many"]
  0ab4b259_5711_27c1_0ec7_58b25e6df3b8 -->|defined in| 776c65da_a3c4_5133_217d_969e536f67b3
  b120db63_918f_e3c3_8f88_36af2e4aad23["withFieldName()"]
  b120db63_918f_e3c3_8f88_36af2e4aad23 -->|calls| 0ab4b259_5711_27c1_0ec7_58b25e6df3b8
  b120db63_918f_e3c3_8f88_36af2e4aad23["withFieldName()"]
  0ab4b259_5711_27c1_0ec7_58b25e6df3b8 -->|calls| b120db63_918f_e3c3_8f88_36af2e4aad23
  style 0ab4b259_5711_27c1_0ec7_58b25e6df3b8 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/relations.ts lines 113–121

	withFieldName(fieldName: string): Many<TTableName> {
		const relation = new Many(
			this.sourceTable,
			this.referencedTable,
			this.config,
		);
		relation.fieldName = fieldName;
		return relation;
	}