foreignKey() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

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

Dependency Diagram

graph TD
  eeeb259e_8785_9b92_b9a2_1ff324985626["foreignKey()"]
  b9d8b4e3_8c35_6c97_3af0_a74313048074["foreign-keys.ts"]
  eeeb259e_8785_9b92_b9a2_1ff324985626 -->|defined in| b9d8b4e3_8c35_6c97_3af0_a74313048074
  style eeeb259e_8785_9b92_b9a2_1ff324985626 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/foreign-keys.ts lines 98–119

export function foreignKey<
	TTableName extends string,
	TForeignTableName extends string,
	TColumns extends [AnyPgColumn<{ tableName: TTableName }>, ...AnyPgColumn<{ tableName: TTableName }>[]],
>(
	config: {
		name?: string;
		columns: TColumns;
		foreignColumns: ColumnsWithTable<TForeignTableName, TColumns>;
	},
): ForeignKeyBuilder {
	function mappedConfig() {
		const { name, columns, foreignColumns } = config;
		return {
			name,
			columns,
			foreignColumns,
		};
	}

	return new ForeignKeyBuilder(mappedConfig);
}