foreignKey() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/foreign-keys.ts lines 105–126

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