Dyalog / Dyalog/DCMS

Investigate generating Mermaid ER diagrams from database schema

Open
#115 0 comments 0 reactions 0 assignees View on GitHub
low priority
Dominant language
APL
Stars
4
Forks
1
PR merge metrics
No merged PRs in 30d

Description

We want ER diagrams that stay in sync with the schema rather than hand-maintained. Investigate whether diagrams can be generated directly from the running MariaDB instance or .sql files.

- [ ] Evaluate [mermerd](https://github.com/KarnerTh/mermerd). Connect to the dev database and assess output quality (table coverage, foreign key rendering, readability)
- [ ] Identify alternatives (e.g. `schemacrawler`, `tbls`, `mysql-to-mermaid`, or a custom SQL query against `information_schema`)
- [ ] Assess whether the chosen tool can run in CI to keep diagrams up to date

We want to balance the benefit of viewable schema to lead to simplification and stability vs the cost of additional dependencies.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.