Diagrammi ER in Confluence

Un diagramma entità-relazione mostra le tabelle di un database, le loro colonne e come le tabelle sono collegate.

Ultimo aggiornamento

Quando usarlo

Usa un diagramma ER per documentare lo schema di un database o per progettarlo prima della prima migrazione. Ogni riquadro è una tabella con colonne e chiavi; ogni linea dice quante righe di un lato corrispondono alle righe dell’altro, per esempio un cliente con molti ordini.

Esempio

Questo è il codice del modello Online shop: clienti, ordini, righe d’ordine e prodotti con le chiavi.

erDiagram
  CUSTOMER ||--o{ ORDER : places
  ORDER ||--|{ ORDER_LINE : contains
  PRODUCT ||--o{ ORDER_LINE : "appears in"
  CUSTOMER {
    int id PK
    string name
    string email
  }
  ORDER {
    int id PK
    date created_at
    string status
  }
  ORDER_LINE {
    int quantity
    decimal unit_price
  }
  PRODUCT {
    int id PK
    string sku
    string name
  }

Vellnar Diagrams lo disegna così:

Cambia una riga e il diagramma cambia con lei. A nessuno serve il file originale del disegno, perché non esiste: il codice è il diagramma.

Aggiungerlo a una pagina di Confluence

  1. Modifica una pagina di Confluence e scrivi /mermaid dove vuoi il diagramma.
  2. Seleziona Mermaid diagram. Si apre l’editor con l’elenco dei modelli.
  3. Scegli un modello, oppure Start blank e incolla il codice qui sopra. L’anteprima segue ogni tasto.
  4. Scegli Save. Il diagramma compare nella pagina.

La documentazione spiega l’editor, le impostazioni e le esportazioni.

Modelli

Il pulsante Templates dell’editor ha 3 modelli pronti per questo tipo:

  • Online shop: Clienti, ordini, righe d’ordine e prodotti con le chiavi.
  • CRM: Account, contatti, opportunità e attività.
  • Star schema: Una tabella dei fatti di vendita unita alle dimensioni data, prodotto, cliente e negozio.

Sintassi

Il codice inizia con erDiagram. La documentazione di Mermaid (in inglese) descrive ogni elemento della sintassi. Vellnar Diagrams lo disegna con Mermaid 12.3; se una riga ha un errore, l’editor segna la riga e tiene a schermo l’ultimo diagramma valido.

Altro

  • Mermaid in Confluence: come funzionano i diagrammi scritti come codice in una pagina, e tutti i tipi di diagramma.
  • Sicurezza: l’app non chiede nessun permesso e non manda nulla fuori da Atlassian.