docs: added multi-column informations for JoinColumn (#5656)

typeorm · Mar 11, 2020 · 6e598c1 · 6e598c1
1 parent f7052a3
commit 6e598c1
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/docs/relations.md b/docs/relations.md
@@ -184,7 +184,18 @@ category: Category;
 ```
 
 The relation now refers to `name` of the `Category` entity, instead of `id`.
-Column name for that relation will become `categoryName`
+Column name for that relation will become `categoryName`.
+
+You can also join multiple columns. Note that they do not reference the primary column of the related entity by default: you must provide the referenced column name.
+
+```typescript
+@ManyToOne(type => Category)
+@JoinColumn([
+    { name: "category_id", referencedColumnName: "id" },
+    { name: "locale_id", referencedColumnName: "locale_id" }
+])
+category: Category;
+```
 
 ## `@JoinTable` options