foreignKey() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

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

export function foreignKey<
	TTableName extends string,
	TForeignTableName extends string,
	TColumns extends [AnyGelColumn<{ tableName: TTableName }>, ...AnyGelColumn<{ 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);
}