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 2

Entity Profile

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

Dependency Diagram

graph TD
  b120db63_918f_e3c3_8f88_36af2e4aad23["withFieldName()"]
  8930e39d_41cd_ddaf_bd38_f1d7428e1a65["One"]
  b120db63_918f_e3c3_8f88_36af2e4aad23 -->|defined in| 8930e39d_41cd_ddaf_bd38_f1d7428e1a65
  0ab4b259_5711_27c1_0ec7_58b25e6df3b8["withFieldName()"]
  0ab4b259_5711_27c1_0ec7_58b25e6df3b8 -->|calls| b120db63_918f_e3c3_8f88_36af2e4aad23
  e2b85fc7_c522_3edc_d997_009cba5088b1["relations()"]
  e2b85fc7_c522_3edc_d997_009cba5088b1 -->|calls| b120db63_918f_e3c3_8f88_36af2e4aad23
  0ab4b259_5711_27c1_0ec7_58b25e6df3b8["withFieldName()"]
  b120db63_918f_e3c3_8f88_36af2e4aad23 -->|calls| 0ab4b259_5711_27c1_0ec7_58b25e6df3b8
  style b120db63_918f_e3c3_8f88_36af2e4aad23 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/relations.ts lines 88–97

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