ER 圖

erDiagram
  CUSTOMER["客戶"] {
    string id PK "帳號"
    string email UK
  }
  CUSTOMER ||--o{ ORDER : places
  ORDER ||--|{ LINE-ITEM : contains
  PRODUCT ||..o{ LINE-ITEM : "appears in"

timeline:
  enter ORDER slide-top, enter CUSTOMER:ORDER fade
  enter LINE-ITEM slide-right, enter ORDER:LINE-ITEM fade
  enter PRODUCT slide-bottom, enter PRODUCT:LINE-ITEM fade, highlight LINE-ITEM glow

標頭

只有 erDiagram,沒有 erDiagram-v2。

實體

  • 寫出名稱就宣告了實體。名稱可以有英數字、_、-、.、* 和中文,例如 LINE-ITEM、訂單。
  • 名稱有空白時加雙引號:"Customer Account"。引號裡的名稱或別名含 %(A["50% off"])會報錯,Mermaid 也拒絕它,請改用文字寫出來。
  • 別名:CUSTOMER["客戶"] 或 CUSTOMER[Client],只改畫出來的名字,id 還是 CUSTOMER。同一個實體有多個別名時以第一個為準。
  • 同一個實體提到很多次會合併成一個,屬性也會合併。
  • 一行可以寫好幾個敘述:A B C 宣告三個實體。
  • 保留字 end、subgraph、class、style、classDef 不能當實體名稱。

屬性

erDiagram
  ORDER {
    int id PK
    string customer_id FK "下單的客戶"
    list~string~ tags
    string `shipping address`
  }
  • 每一個屬性寫成 型別 名稱 [鍵] ["註解"]。
  • 鍵可以是 PK、FK、UK,多個之間用逗號分隔且不能有空白(PK,FK),要寫在註解之前。
  • 泛型寫成 list~string~。
  • 名稱有特殊字元時用反引號包起來。
  • 區塊可以寫在一行:E { string a }。

關係

寫法是 左邊 <基數><線><基數> 右邊 : 標籤,標籤一定要有。

基數 符號 文字寫法
剛好一個 || one、only one、1
零或一個 |o、o| zero or one、one or zero
零或多個 }o、o{ zero or more、zero or many、many、many(0)、0+
一或多個 }|、|{ one or more、one or many、many(1)、1+
線 寫法
實線(identifying) -- 或 to
虛線(non-identifying) ..、.-、-. 或 optionally to
erDiagram
  CUSTOMER ||--o{ ORDER : places
  ORDER |o..|{ ITEM : contains
  PRODUCT one to zero or many ITEM : "appears in"
  • 左右兩側都可以寫任一種基數,左邊寫的就畫在左邊。
  • 標籤是一個字,或用引號包起來的字串。: two words 會變成標籤 two 加上一個叫 words 的實體,和 Mermaid 相同。
  • 標籤畫在線上,底下墊一塊主題 --siren-edge-label-fill 的底色;寬度超過大約 171px 會自己換行(一行放的字和 Mermaid 一樣多,Mermaid 把這個標籤畫得比較大),<br> 也能換行。實體名稱、別名和屬性的註解不會換行。

Subgraph

erDiagram
  subgraph sales ["銷售"]
    CUSTOMER ||--o{ ORDER : places
  end
  ORDER ||--|{ ITEM : contains
  • subgraph 名稱、subgraph 名稱["標題"] 或 subgraph 名稱 [標題],以 end 結束。
  • 可以巢狀,每一層可以有自己的 direction。但只要有一條關係兩端的父層不同、又穿過這個 subgraph,它就會放棄自己的方向:一端的實體在裡面(不管多深)、一端在外面就算,兩端都是它自己的實體但巢狀深度不同也算。這樣的關係會讓從兩端往上、直到兩端最近的共同 subgraph(含)的每一層都放棄方向,改用外層 subgraph 的方向(找最近一層還保有自己方向的),都沒有就用整張圖的,和 Mermaid 12 相同。沒寫 direction 的 subgraph 也一樣,跟著外層 subgraph 的方向排。
  • 同一層的 subgraph 後寫的排前面,而且所有 subgraph 都排在外面的實體前面,和 Mermaid 相同:先寫 subgraph SA、再寫 subgraph SB、最後 X,從左到右會是 SB、SA、X。
  • 在 subgraph 裡寫的關係,兩端的實體都會被放進這個 subgraph。
  • subgraph 名稱不能和實體名稱相同。

方向

direction TB、BT、LR、RL,寫了好幾次的話以最後一個為準。不接受 TD:Mermaid 會把 direction TD 讀成兩個實體,Siren 也一樣。

樣式

erDiagram
  CUSTOMER ||--o{ ORDER : places
  ORDER:::urgent
  style CUSTOMER fill:#dbeafe,stroke:#2563eb
  classDef urgent fill:#fee2e2,stroke:#dc2626
  • style A,B 屬性:值,...
  • classDef a,b 屬性:值,...:可以一次定義多個名稱。
  • class A,B 名稱1,名稱2
  • A:::名稱,也可以接在別名後面:A["x"]:::名稱。
  • style 和套在同一個實體上的類別,不管哪一行先寫都是 style 贏,和 Mermaid 相同。套用沒有定義的類別是警告:實體照畫,只是沒有樣式。
  • 關係不能上樣式。
  • subgraph 外框的底色是主題的 --siren-subgraph-fill,預設 none,見主題。
  • timeline 的 highlight 一律贏過作者寫的 stroke:實體被強調時,outline 和 glow 用強調色畫它的外框,結束後再把作者的還回去。

ER 圖 style、classDef 的值照 Mermaid 能讀的字元來讀,所以比流程圖嚴格:

  • 只能有英數字、非 ASCII 字元、空白、-、_、*、#、:、,。顏色請寫色碼或名稱(fill:#f96、fill:red),尺寸請寫整數(stroke-width:2)。函式(rgb(…))、小數(1.5px)、!important、引號、$、%、/ 都會報錯。
  • 值裡面不能有空白:Mermaid 會把兩個字黏在一起,stroke-dasharray:5 5 會畫成 55,所以 Siren 拒絕它。: 或 , 旁邊的空白則沒關係。
  • ; 只能在整行的最後(fill:red;),後面再接東西就報錯。空的宣告(fill:red,、style A ;)、一個宣告裡第二個 :(fill:red:blue)、宣告前面緊接的 ,(style A ,fill:red)也都報錯,訊息會說要怎麼改。

無障礙

accTitle: 標題、accDescr: 描述 和大括號的 accDescr { ... } 區塊,不分大小寫,冒號前面可以有空白,以最後一個為準。accTitle { 沒有區塊寫法,會讀成一個叫 accTitle 的實體,和 Mermaid 相同。

註解

只有整行才是註解。關係的引號標籤、屬性的引號註解、反引號名稱和泛型裡的 %% 是文字;寫在一行的其他地方會報錯,請把註解搬到單獨一行;只有 %% 的一行也會被拒絕。

Timeline 目標

元素 id 例子
實體 實體名稱(不是別名) CUSTOMER(CUSTOMER["客戶"])
關係 左邊:右邊,用冒號分隔,重複的加 #2 CUSTOMER:ORDER
subgraph subgraph:N,依開啟順序編號,名稱不能用 subgraph:1
  • 關係用冒號而不是 -,因為實體名稱本身可以有 -(ORDER:LINE-ITEM)。
  • 名稱有空白的實體("Customer Account")無法在 timeline 裡指定,因為目標不能有空白。需要動畫的實體請用不含空白的名稱,再用別名顯示。
  • 屬性不能單獨當目標。

尚未支援

語法 目前的行為
u 基數(A u--o{ B : x) 報錯。Mermaid 也畫不出它的符號
classDef default 報錯
在 subgraph 的 end 之後對它用 style / class 報錯
對關係用 style(style A:B ...) 報錯
用 one、to、many 等基數字當實體名稱(CUSTOMER one ORDER) 不會報錯,但會畫成三個實體,Mermaid 則會報錯
數字開頭的名稱(123abc) 不會報錯,但畫成一個實體,Mermaid 會畫成兩個