orcahouse-doc

erd Model Guide

We use https://github.com/dineug/erd-editor (Entity Relationship Diagram Editor) tool to keeping tracked of “data model” being developed at different layers of the warehouse. The following are recommended setup to visualise ERD model documentation.

Warehouse

• OrcaVault

VSCode

1. Install Visual Studio Code (VSCode)
2. Install “ERD Editor” extension at https://marketplace.visualstudio.com/items?itemName=dineug.vuerd-vscode
3. Open the ERD model file e.g. File > Open > orcavault/orcavault_dcl.erd.json

Online

1. Go to https://erd-editor.io/
2. Click New Schema and give schema name: orcavault_dcl
3. Select orcavault_dcl schema at left panel.
4. At right editor panel, Right Click > Import > orcavault/orcavault_dcl.erd.json

Note

• Please note that the ERD model published here may lag behind the latest development.
• Using the online WebApp version stores changes only in your Browser cache storage. So do any changes made locally with VSCode IDE.
• For using ERD editor guide, refer to https://docs.erd-editor.io/docs/category/guides/