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
  95d098ff_b8e3_4a5e_8edf_7cd48eac3b85["foreignKey()"]
  fab980e5_64f0_d7af_6cbf_9d6014d326a4["foreign-keys.ts"]
  95d098ff_b8e3_4a5e_8edf_7cd48eac3b85 -->|defined in| fab980e5_64f0_d7af_6cbf_9d6014d326a4
  style 95d098ff_b8e3_4a5e_8edf_7cd48eac3b85 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/sqlite-core/foreign-keys.ts lines 128–144

export function foreignKey(
	config: any,
): ForeignKeyBuilder {
	function mappedConfig() {
		if (typeof config === 'function') {
			const { name, columns, foreignColumns } = config();
			return {
				name,
				columns,
				foreignColumns,
			};
		}
		return config;
	}

	return new ForeignKeyBuilder(mappedConfig);
}