relations() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery calls 1

Entity Profile

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

Dependency Diagram

graph TD
  e2b85fc7_c522_3edc_d997_009cba5088b1["relations()"]
  2f47d090_425d_2e56_2395_4c4d912316f0["relations.ts"]
  e2b85fc7_c522_3edc_d997_009cba5088b1 -->|defined in| 2f47d090_425d_2e56_2395_4c4d912316f0
  b120db63_918f_e3c3_8f88_36af2e4aad23["withFieldName()"]
  e2b85fc7_c522_3edc_d997_009cba5088b1 -->|calls| b120db63_918f_e3c3_8f88_36af2e4aad23
  style e2b85fc7_c522_3edc_d997_009cba5088b1 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/relations.ts lines 502–519

export function relations<
	TTableName extends string,
	TRelations extends Record<string, Relation<any>>,
>(
	table: AnyTable<{ name: TTableName }>,
	relations: (helpers: TableRelationsHelpers<TTableName>) => TRelations,
): Relations<TTableName, TRelations> {
	return new Relations<TTableName, TRelations>(
		table,
		(helpers: TableRelationsHelpers<TTableName>) =>
			Object.fromEntries(
				Object.entries(relations(helpers)).map(([key, value]) => [
					key,
					value.withFieldName(key),
				]),
			) as TRelations,
	);
}