CLI tool for converting SQL table dependencies to mermaid.js format.
Project description
sql2mermaid-cli
sql2mermaid-cli
is a CLI tool that converts SQL query into mermaid.js style!.
Required
Python >=3.8.1
Installation
To install sql2mermaid-cli, use the following command:
$ pip install sql2mermaid-cli
Getting Started
As a preparation, create a sample SQL file.
$ echo "with bar as (select * from baz)\n\
select * from foo inner join bar on foo.id = bar.id\n"> input.sql
The basic usage of sql2mermaid-cli
is as follows:
$ sql2mermaid-cli -i input.sql
This will output the mermaid diagram to the console:
graph LR
bar([bar])
root([root])
baz[(baz)]
foo[(foo)]
bar --> baz
root --> foo
root --> bar
The Mermaid diagram that is outputted can be visualized on the Mermaid Live Editor website.
Options
To save the output to a file, use the -o option followed by the path to the output file:
$ sql2mermaid-cli -i input.sql -o output.txt
By default, the output format is plain text. To output the mermaid diagram in markdown format, use the -m option:
$ sql2mermaid-cli -i input.sql -o output.md -m
You can also specify either "upper" or "lower" after the -d option to display the join type of SQL in the mermaid diagram.
$ sql2mermaid-cli -i input.sql -d upper
This will output the mermaid diagram to the console:
graph LR
bar([bar])
foo([foo])
root[(root)]
baz[(baz)]
foo.id[(foo.id)]
bar.id[(bar.id)]
bar -- FROM --> baz
bar -- FROM --> foo
foo -- INNER JOIN --> bar
Author
License
This project is licensed under the MIT License - see the LICENSE.md for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sql2mermaid_cli-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dd1dcba3859cc8137df48d4a7455564d672e636a60ad871f90c4b06dc3c1c74 |
|
MD5 | ed7e5de895c3e70bda02dfc8b5936e8f |
|
BLAKE2b-256 | 964e0f19ce2b987fa106f04acb75a85e3c0daa6a20933b0cf565997bc498da68 |