-
Notifications
You must be signed in to change notification settings - Fork 14.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[36842] Add pre-commit script to generate ER mermaid diagram from SQL… #42323
base: main
Are you sure you want to change the base?
[36842] Add pre-commit script to generate ER mermaid diagram from SQL… #42323
Conversation
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
|
README.md
Outdated
@@ -255,6 +256,424 @@ following the ASF Policy. | |||
|
|||
![Code](https://raw.githubusercontent.com/apache/airflow/main/docs/apache-airflow/img/code.png) | |||
|
|||
## Database scheme |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it necessary to put this in README? I’m not sure that’s particularly useful TBH…
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really, we should find a better place to embed it. It was just the first markdown file I found. Any suggestions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The user-facing documentation already has an image, so maybe somewhere in contributing-docs
? IIRC there’s a document there on database models.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately I can't inject the mermaid in the rst file so I just replace the svg file instead
and restore the original README
https://github.com/dennysreg/airflow/blob/issue-36842-generate-a-mermaid-erd-diagram-from-sqlalchemy-models/docs/apache-airflow/database-erd-ref.rst
@dennysreg - do you think you can rebase it and make it ready to be merged? |
Closes: #36842
Use paracelsus to generate the
docs/apache-airflow/img/airflow_erd.svg
file based on SQLAlchemy models.Before
After
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rst
or{issue_number}.significant.rst
, in newsfragments.