viniciusdev26/Generate Database ER Diagram (Mermaid)
Generate ER diagram in Mermaid format from PostgreSQL or MySQL databases and update README
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| db-type | Type of database (postgresql or mysql) | no | postgresql |
| db-host | Host of the database | no | localhost |
| db-port | Port of the database | no | 5432 |
| db-name | Name of the database | yes | — |
| db-user | User of the database | yes | — |
| db-pass | Password of the database | yes | — |
| output-dir | Directory where the diagram will be saved | no | docs |
| write-to-readme | Whether to write the diagram to the README file | no | false |
| readme-path | Path to the README file | no | README.md |
| excluded-tables | Comma-separated list of table names to exclude from the diagram | no | flyway_schema_history |
| show-indexes | Whether to show database indexes in the diagram | no | true |
| auto-commit | Automatically commit and push changes to the repository | no | false |
| commit-message | Commit message for auto-commit | no | docs: update ER diagram [skip ci] |
| commit-author-name | Author name for the commit | no | github-actions[bot] |
| commit-author-email | Author email for the commit | no | 41898282+github-actions[bot]@users.noreply.github.com |
Outputs
no outputs