search

datajoint / datajoint-docs-original

https://docs.datajoint.org
Other
2 stars 13 forks source link

"ERD" should be "schema diagram". #122

Open austin-hilberg opened 5 years ago

austin-hilberg commented 5 years ago

dj.ERD will (likely) become dj.Diagram. Remove ERD from the language. See Issue 255

CBroz1 commented 2 years ago

During this overhaul/renaming to Diagram, I would suggest the following as a description of the symbols used, emphasizing the visual elements. Edits for lines 24-29.

* :ref:`Data tiers <tiers>` are indicated as colors and symbols:
   * Manual table: green box, manually inserted, expect new entries daily.
   * Lookup table: gray box, preinserted table, commonly used for general facts or parameters.
   * Imported table: blue oval, auto-processing depends on the importing of external files.
   * Computed table: red circle, auto-processing does not depend on external files.
   * :ref:`Part table <master-part>`: black dot, with smaller font. An appendix to a master, all entries represent a intact set of the master entry. 
* :ref:`dependencies` are indicated as edges in the graph and always directed downward, forming a **directed acyclic graph**.
   * Solid lines: Foreign keys are contained within the primary key, meaning that the referenced table becomes part of the primary key of the dependent table. The child table's primary key comes from the parent table, but has additional field(s) as part of the primary key. This is a one-to-many relationship.
   * Dashed lines: Foreign keys are outside the primary key.
   * Thick solid line: The primary key of the dependent table has no other attributes besides the foreign key, meaning the child table inherits all the primary key fields from the parent table as its own primary key. This is a one-to-one (or one-to-zero) relationship.
   * Color black/red: Foreign keys made without renaming attributes are in black, whereas those that rename are indicated in red.