marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-16 13:59:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc(er): add documentation on multiple key constraints

Browse Source
This commit is contained in:
Tom PERRILLAT-COLLOMB
2023-01-25 15:13:58 +01:00
parent 26e9b1790b
commit 3066a4b43a
3 changed files with 47 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
demos/er.html
View File

@@ -85,6 +85,30 @@
> >
<hr /> <hr />
<pre class="mermaid">
erDiagram
CAR ||--o{ NAMED-DRIVER : allows
CAR {
string registrationNumber PK
string make
string model
string[] parts
}
PERSON ||--o{ NAMED-DRIVER : is
PERSON {
string driversLicense PK "The license #"
string(99) firstName "Only 99 characters are allowed"
string lastName
string phone UK
int age
}
NAMED-DRIVER {
string carRegistrationNumber PK,FK
string driverLicence PK,FK
}
MANUFACTURER only one to zero or more CAR : makes
</pre>
<script src="./mermaid.js"></script> <script src="./mermaid.js"></script>
<script type="module"> <script type="module">
mermaid.initialize({ mermaid.initialize({

22
docs/syntax/entityRelationshipDiagram.md
View File

@@ -200,14 +200,13 @@ The `type` and `name` values must begin with an alphabetic character and may con
#### Attribute Keys and Comments #### Attribute Keys and Comments
Attributes may also have a `key` or comment defined. Keys can be "PK", "FK" or "UK", for Primary Key, Foreign Key or Unique Key. And a `comment` is defined by double quotes at the end of an attribute. Comments themselves cannot have double-quote characters in them. Attributes may also have a `key` or comment defined. Keys can be `PK`, `FK` or `UK`, for Primary Key, Foreign Key or Unique Key. To specify multiple key constraints on a single attribute, separate them with a comma (e.g., `PK,FK`).. A `comment` is defined by double quotes at the end of an attribute. Comments themselves cannot have double-quote characters in them.
```mermaid-example ```mermaid-example
erDiagram erDiagram
CAR ||--o{ NAMED-DRIVER : allows CAR ||--o{ NAMED-DRIVER : allows
CAR { CAR {
string allowedDriver FK "The license of the allowed driver" string registrationNumber PK
string registrationNumber UK
string make string make
string model string model
string[] parts string[] parts
@@ -217,17 +216,21 @@ erDiagram
string driversLicense PK "The license #" string driversLicense PK "The license #"
string(99) firstName "Only 99 characters are allowed" string(99) firstName "Only 99 characters are allowed"
string lastName string lastName
string phone UK
int age int age
} }
MANUFACTURER only one to zero or more CAR NAMED-DRIVER {
string carRegistrationNumber PK,FK
string driverLicence PK,FK
}
MANUFACTURER only one to zero or more CAR : makes
``` ```
```mermaid ```mermaid
erDiagram erDiagram
CAR ||--o{ NAMED-DRIVER : allows CAR ||--o{ NAMED-DRIVER : allows
CAR { CAR {
string allowedDriver FK "The license of the allowed driver" string registrationNumber PK
string registrationNumber UK
string make string make
string model string model
string[] parts string[] parts
@@ -237,9 +240,14 @@ erDiagram
string driversLicense PK "The license #" string driversLicense PK "The license #"
string(99) firstName "Only 99 characters are allowed" string(99) firstName "Only 99 characters are allowed"
string lastName string lastName
string phone UK
int age int age
} }
MANUFACTURER only one to zero or more CAR NAMED-DRIVER {
string carRegistrationNumber PK,FK
string driverLicence PK,FK
}
MANUFACTURER only one to zero or more CAR : makes
``` ```
### Other Things ### Other Things

12
packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md
View File

@@ -146,14 +146,13 @@ The `type` and `name` values must begin with an alphabetic character and may con
#### Attribute Keys and Comments #### Attribute Keys and Comments
Attributes may also have a `key` or comment defined. Keys can be "PK", "FK" or "UK", for Primary Key, Foreign Key or Unique Key. And a `comment` is defined by double quotes at the end of an attribute. Comments themselves cannot have double-quote characters in them. Attributes may also have a `key` or comment defined. Keys can be `PK`, `FK` or `UK`, for Primary Key, Foreign Key or Unique Key. To specify multiple key constraints on a single attribute, separate them with a comma (e.g., `PK,FK`).. A `comment` is defined by double quotes at the end of an attribute. Comments themselves cannot have double-quote characters in them.
```mermaid-example ```mermaid-example
erDiagram erDiagram
CAR ||--o{ NAMED-DRIVER : allows CAR ||--o{ NAMED-DRIVER : allows
CAR { CAR {
string allowedDriver FK "The license of the allowed driver" string registrationNumber PK
string registrationNumber UK
string make string make
string model string model
string[] parts string[] parts
@@ -163,9 +162,14 @@ erDiagram
string driversLicense PK "The license #" string driversLicense PK "The license #"
string(99) firstName "Only 99 characters are allowed" string(99) firstName "Only 99 characters are allowed"
string lastName string lastName
string phone UK
int age int age
} }
MANUFACTURER only one to zero or more CAR NAMED-DRIVER {
string carRegistrationNumber PK,FK
string driverLicence PK,FK
}
MANUFACTURER only one to zero or more CAR : makes
``` ```
### Other Things ### Other Things