chore: add a model overview in readme (amundsen-io#22)

* added model overview in readme Signed-off-by: xuans <[email protected]> * updated a relationship Signed-off-by: xuans <[email protected]> --------- Signed-off-by: xuans <[email protected]>
xuan616 · Apr 10, 2023 · bea0494 · bea0494
1 parent 8d9bc1d
commit bea0494
Showing 1 changed file with 56 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,62 @@ Amundsenrds contains ORM models to support relational database as metadata backe
 The schema in ORM models follows the logic of [databuilder models](https://github.com/amundsen-io/amundsendatabuilder/tree/master/databuilder/models).
 Amundsenrds will be used in [databuilder](https://github.com/amundsen-io/amundsendatabuilder) and [metadatalibrary](https://github.com/amundsen-io/amundsenmetadatalibrary) for metadata storage and retrieval with relational databases.
 
+## Model overview
+```mermaid
+erDiagram  
+Database ||--o{ Cluster : "" 
+Cluster ||--o{ Schema : "" 
+Schema ||--o{ Table : ""
+Schema ||--o| SchemaDescription : ""
+Schema ||--o{ SchemaProgrammaticDescription : ""
+Table ||--o| ApplicationTable : ""
+Application ||--o{ ApplicationTable : ""
+Table ||--o{ TableLineage : ""
+TableLineage ||--|{ Table : ""
+Table ||--o| TableDescription : ""
+Table ||--o{ TableProgrammaticDescription : ""
+Table ||--o| TableTimestamp : ""
+Table ||--o{ TableTag : ""
+Table ||--o{ TableBadge : ""
+Badge ||--o{ TableBadge : ""
+Table ||--o{ TableOwner : ""
+Table ||--o{ TableFollower : ""
+Table ||--o{ TableWatermark : ""
+Table ||--o| TableSource : ""
+Table ||--o{ TableUsage : ""
+Table ||--|{ TableColumn : ""
+TableColumn ||--o| ColumnDescription : ""
+TableColumn ||--o{ ColumnStat : ""
+TableColumn ||--o{ ColumnLineage : ""
+ColumnLineage ||--|{ TableColumn : ""
+TableColumn ||--o{ ColumnBadge : ""
+Badge ||--o{ ColumnBadge : ""
+DashboardCluster ||--o{ DashboardGroup : ""
+DashboardGroup ||--o{ Dashboard : ""
+Dashboard ||--o{ DashboardBadge : ""
+Badge ||--o{ DashboardBadge : ""
+Dashboard ||--o| DashboardDescription : ""
+Dashboard ||--o| DashboardTimestamp : ""
+Dashboard ||--o{ DashboardTag : ""
+Dashboard ||--o{ DashboardOwner : ""
+Dashboard ||--o{ DashboardFollower : ""
+Dashboard ||--o{ DashboardUsage : ""
+Dashboard ||--o{ DashboardTable : ""
+Table ||--o{ DashboardTable : ""
+Dashboard ||--o{ DashboardExecution : ""
+Dashboard ||--o{ DashboardQuery : ""
+DashboardQuery ||--o{ DashboardChart : ""
+Tag ||--o{ DashboardTag : ""
+DashboardGroup ||--o| DashboardGroupDescription : ""
+User ||--o{ TableOwner : ""
+User ||--o{ TableFollower : ""
+User ||--o{ TableUsage : ""
+User ||--o{ DashboardOwner : ""
+User ||--o{ DashboardFollower : ""
+User ||--o{ DashboardUsage : ""
+UpdatedTimestamp
+```
+
 ## Requirements
 - Python: >= 3.6
 - MySQL: 5.7, 8