Skip to content

Commit dce9033

Browse files
docs: add missing Platform model in diagram
1 parent a44120b commit dce9033

File tree

3 files changed

+367
-324
lines changed

3 files changed

+367
-324
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,14 @@ The service deploys two containers (which both use the same image/Python environ
138138
# Database Schema Diagram Update
139139
When the database models are changed, the database schema diagram in `db_diagram.svg` should be updated to reflect the changes.
140140

141-
## Prerequisites
141+
### Prerequisites
142142
- `graphviz` (install via Homebrew on macOS: `brew install graphviz`)
143143

144144

145+
### Generating the Diagram
146+
147+
The `aai-backend/scripts/generate_db_diagram.py` script generates a database schema diagram from the SQLAlchemy models defined in the codebase, when a models are added, removed, or modified, the `models` module should be updated accordingly.
148+
145149
To generate an updated database schema diagram, run the following command:
146150

147151
```shell

0 commit comments

Comments
 (0)