question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Consider offering syntax like PlantUML for ER diagrams

See original GitHub issue

I just added the capability to render entity relationship diagrams to mermaid, and made up a simple syntax, e.g. PERSON !-?< ACCOUNT : holds is interpreted as a person holds zero or more accounts and an account must be held by one and only one person.

PlantUML has a similar-but-different syntax which is also pretty intuitive (and of course already in use). For example PERSON ||..o{ ACCOUNT means the same thing (although the relationship label holds is missing). An additional nuance of PlantUML appears to be that using either dots or dashes in the relationship one can distinguish between identifying and non-identifying relationships.

@Dunning-Kruger has suggested use of PlantUML syntax - seems like a good idea. What do others think?

  • Should we just ditch my syntax in favour of PlantUML style (I have no issue with this at all)
  • Should we offer two alternative styles? (Given that ER diagrams are not live yet, I’m not sure it’s worth it)
  • Any other thoughts? As @knsv pointed out in the original trail of issue #117 it’s important to spend time now getting this right, as it will be hard to change later, without screwing existing users
  • Ofc I could extend the PlantUML syntax to include the relationship label as this is a useful (and pretty standard in my experience - in fact it’s regarded as mandatory by some)

Comments greatly appreciated. Thx.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:6 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
spopidacommented, Mar 19, 2020

No problem - I should’ve thought of it myself - at least you did! I’ll do some work on it and post here when appropriate.

0reactions
GDFabercommented, Mar 25, 2020

Thank you for looking into this.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Entity Relationship diagram syntax and features - PlantUML
Entity Relationship Diagram. Based on the Information Engineering notation. This is an extension to the existing Class Diagram. This extension adds:.
Read more >
An approach to UML Diagrams and ER Models Bearable for a ...
A process to generate UML diagrams and ER models that is bearable to software engineers. I have developed it while working at Groupon....
Read more >
An ecosystem of tools around PlantUML to render textual UML ...
PlantUML supports all important UML diagrams (class, use case, activity, sequence, component, deployment and object diagrams, see the language ...
Read more >
PlantUML Language Reference Guide
The following non-UML diagrams are also supported: ... You can directly make a note over all participants, with the syntax: ... participant Alice...
Read more >
Diagramming software architecture using C4 model and C4 ...
PlantUML is an open source project that allows you to quickly produce diagrams just by using plain text. It can be used to...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found