Skip to content
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

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

dennysreg
Copy link

@dennysreg dennysreg commented Sep 18, 2024

Closes: #36842

Use paracelsus to generate the docs/apache-airflow/img/airflow_erd.svg file based on SQLAlchemy models.

NOTE: The same tool could be use to generate a mermaid code and inject it to a Markdown file but it seems like rst format is not supported yet.

Before
image

After
image


^ 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.

Copy link

boring-cyborg bot commented Sep 18, 2024

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)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

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
Copy link
Member

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…

Copy link
Author

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?

Copy link
Member

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.

Copy link
Author

@dennysreg dennysreg Sep 21, 2024

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
image

@potiuk
Copy link
Member

potiuk commented Oct 2, 2024

@dennysreg - do you think you can rebase it and make it ready to be merged?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate a mermaid diagram for the database ERD schema
4 participants