Rotorsoft/issue5293 - Create a shell script to read the current database schema and generate a mermaid ERD in the wiki space

[Rotorsoft]

Link to Issue

Closes: #5293

Description of Changes

• created sql query to read pg metadata and generate mermaid erd schema
• created shell script to save results in wiki/ERD.md

Test Plan

• Execute yarn workspace commonwealth db-doc to generate a fresh copy of ./knowledge_base/wiki/ERD.md

Other Considerations

• not integrated in the ci/cd pipeline yet, can be added to db-all script if necessary

[gdjohnson]

This is awesome! Super cool idea elegantly implemented.

My only big-picture concern is that it's such an enormous ERD, it's difficult to view or navigate visually. Curious if you have any advice, or what you've been using to visually navigate the generated ERD.

[rbennettcw]

Nice.

Looks like the script assumes that Postgres is running directly on the host machine? For those of us who run Postgres in Docker (Compose) it would be nice to have a script (or documentation including the script) that can work in that context.

[Rotorsoft]

Nice.

Looks like the script assumes that Postgres is running directly on the host machine? For those of us who run Postgres in Docker (Compose) it would be nice to have a script (or documentation including the script) that can work in that context.

I also run PG in docker, it should work unless you are using a different PG config.
Assuming the standard I found for local dev, but can be modified to use .env

[Rotorsoft]

This is awesome! Super cool idea elegantly implemented.

My only big-picture concern is that it's such an enormous ERD, it's difficult to view or navigate visually. Curious if you have any advice, or what you've been using to visually navigate the generated ERD.

I normally use the mermaid live editor - https://mermaid.live , but the Github integration should be good enough. There is also the Miro and VSCode integrations... https://mermaid.js.org/ecosystem/integrations-community.html

[rbennettcw]

Nice.
Looks like the script assumes that Postgres is running directly on the host machine? For those of us who run Postgres in Docker (Compose) it would be nice to have a script (or documentation including the script) that can work in that context.

I also run PG in docker, it should work unless you are using a different PG config. Assuming the standard I found for local dev, but can be modified to use .env

Do you have psql installed on the host?

[Rotorsoft]

Nice.
Looks like the script assumes that Postgres is running directly on the host machine? For those of us who run Postgres in Docker (Compose) it would be nice to have a script (or documentation including the script) that can work in that context.

I also run PG in docker, it should work unless you are using a different PG config. Assuming the standard I found for local dev, but can be modified to use .env

Do you have psql installed on the host?

yes

[gdjohnson]

Looks like a minor merge conflict, otherwise looks good from a documentation perspective, thanks for the swift changes.

I wasn't having great luck with an ERD this size using Matt Bierner's Markdown Mermaid Support extension for VSCode, but I'll give the official Mermaid extension a shot. Either way, a minor consideration.