Skip to content

Commit f38b6ea

Browse files
authored
Merge pull request #6 from LIDSOL/feat-documentation-create-diagram
Feat: adding the corresponding documentation for creating diagrams.
2 parents 0d3b4bd + 4ccdb01 commit f38b6ea

File tree

7 files changed

+21
-7
lines changed

7 files changed

+21
-7
lines changed

docs/create-diagram.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The following databases are supported:
3939
- MSSQL
4040
- Oracle
4141

42-
For the momment the import SQL diagram has not enable for Oracle Data Base.
42+
For the moment the import SQL diagram has not been enabled for Oracle Data Base.
4343

4444
<ThemedImage
4545
lightImageSrc={require("./img/light/pick-db.png").default}
@@ -93,25 +93,39 @@ You can define the following fields for an index:
9393

9494
## Relationships
9595

96-
To create relationships and define foreign keys, click and hold the blue dot on the foreign key column, then drag and drop it onto the primary column. This action follows the logic of `start_col REFERENCES end_col`, where the column you drag from will be designated as the foreign key, linking it to the primary key in the destination column.
96+
To create a relationship and define foreign keys, click and hold the blue dot on the primary key and drag it to the table with which you want to form the relationship. This will cause a new row to be automatically generated in the child table that will have the primary key information.
9797

9898
<ThemedImage
9999
lightImageSrc={require("./img/light/create-relationship.gif").default}
100100
darkImageSrc={require("./img/dark/create-relationship.gif").default}
101101
alt="Create a relationship"
102102
/>
103103

104-
E.g. in the image above, since `posts.user_id` is the foreign key we start dragging from `user_id` to `users.id`.
104+
The gif shows one of three possible notations selectable in the modeler; for each notation, the rendering and some actions may change.
105105

106-
If at some point you realize that the keys are flipped you can swap them from the `Relationships` tab. Open the relationship you'd like to edit, click on the more button (three dots) next to the primary and forign columns, and then swap.
106+
<!--If at some point you realize that the keys are flipped you can swap them from the `Relationships` tab. Open the relationship you'd like to edit, click on the more button (three dots) next to the primary and forign columns, and then swap. -->!
107+
108+
To delete the relationship, simply double-click on the relationship and select the delete button or delete the auto-generated foreign key from the table.
107109

108110
You can define the following fields for a relationship:
109111

110112
- Name
113+
- Relationship type
114+
- One to One
115+
- One to Many
116+
- Subtype
111117
- Cardinality
112-
- One to One
113-
- One to Many
114-
- Many to One
118+
- Only available for One to one
119+
- (0,1)
120+
- (0,1)
121+
- Only available for One to Many
122+
- (0,*)
123+
- (1,*)
124+
- Subtype restriction (Only available for Subtype relations)
125+
- Disjoint Total
126+
- Disjoint Partial
127+
- Overlaping Total
128+
- Overlaping Partial
115129
- On Delete Action
116130
- On Update Action
117131
- No action
313 KB
Loading

docs/img/dark/define-tables.gif

899 KB
Loading

docs/img/dark/many-to-many.png

23.7 KB
Loading
229 KB
Loading

docs/img/light/define-tables.gif

953 KB
Loading

docs/img/light/many-to-many.png

24.3 KB
Loading

0 commit comments

Comments
 (0)