Fix typos, debugging
[erdiag.git] / README.md
CommitLineData
525c4d2a
BA
1# erdiag: Entity-Relationship Diagrams Generator
2
3Inspired by [this repository](https://code.google.com/archive/p/merisier/).
4
5This parser reads ER diagrams definition files, and produces two types of diagrams + SQL code.
6[Graphviz](https://www.graphviz.org/) is used on server side to translate parsed graph descriptions into SVG objects.
7
19addd10 8*TODO list:* functional integrity constraints (CIF), inter-relations constraints (or, and, xor...), inheritance with the right symbol (triangle).
48a55161 9
19addd10 10*Note:* temporary dependency to [underscore](http://underscorejs.org/); good library but used so far only for its shuffle() method.
525c4d2a
BA
11
12-----
13
14An entity is defined as follow
fe021b27 15
bf4fc3ed
BA
16 [Entity]
17 #attr1 (*)
18 attr2 (*)
fe021b27 19
525c4d2a
BA
20with (\*) = optional SQL indications, and # denoting a (part of) a key.
21
22A relationship is defined in this way
fe021b27 23
bf4fc3ed
BA
24 {Relation}
25 Entity C1
26 Entity2 C2
27 --
28 attr1 (*)
29 attr2 (*)
fe021b27 30
525c4d2a
BA
31where attributes are optional, and C1 (resp. C2) = cardinality for entity 1 (resp. 2).
32Defining relationships with more than two attributes is easy: just add entities.
33Cardinality dictionary:
34 * \* = 0..n
fe021b27 35 * \+ = 1..n
525c4d2a
BA
36 * 1 = 1..1
37 * ? = 0..1
38
19addd10
BA
39Special cardinalities are also available to indicate relative identification: `?R` and `1R`.
40
525c4d2a 41To mark a weak entity, just surround its name by extra-brackets
fe021b27 42
525c4d2a 43 [[WeakEntity]]
fe021b27 44
525c4d2a 45In the same way, a weak relation can be written
fe021b27 46
525c4d2a 47 {{WeakRelation}}
fe021b27 48
525c4d2a
BA
49The syntax for these two last is then the same as in the non-weak versions.
50
51To indicate an inheritance relation, proceed as follow
fe021b27 52
bf4fc3ed
BA
53 is_a
54 Animal Cat Fish
55 Planet Mars Venus
525c4d2a 56
fe021b27 57Finally, blocks must be separated by new lines. For a usage example, see example.html (it should render as seen in example.svg)
525c4d2a
BA
58
59Note that the "drawMcd" method can take a second argument, which indicates the type of graph.
60 * "bubble" draws the standard graph, as seen [here](https://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model#/media/File:ER_Diagram_MMORPG.png) for example
61 * "compact" (default) use the same box for an entity and its attributes