Skip to main content

Convert SQL table dependencies to mermaid.js

Project description


PyPI - License GitHub Workflow Status (with event) PyPI PyPI - Python Version

sql2mermaid

Convert SQL table dependencies to the text of mermaid.js style!

Required

Python >=3.8.1

Installation

pip install sql2mermaid

Getting Started

import sql2mermaid

sql = """
with bar as (select * from baz)
select * from foo inner join bar on foo.id = bar.id
"""

txt = sql2mermaid.convert(sql)
print(txt)

Result

graph LR

bar([bar])
root([root])

baz[(baz)]
foo[(foo)]

bar --> baz
root --> foo
root --> bar

You can get a diagram of the table dependencies by pasting this into Mermaid Live Editor, Diagrams.net (Draw.io), etc.

Options

You can change the name of the root and whether the FROM, JOIN clause is displayed.

How to Develop

If you've installed Poetry on your machine, you can test it by doing the following:

poetry run tox

Author

License

This project is licensed under the MIT License - see the LICENSE.md for details

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sql2mermaid-1.1.1.tar.gz (4.1 kB view hashes)

Uploaded Source

Built Distribution

sql2mermaid-1.1.1-py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page