#script #mermaid #sql #charts #input #icons #show

bin+lib esquel

create mermaid charts from sql scripts

3 releases

0.1.2 Apr 9, 2022
0.1.1 Mar 18, 2022
0.1.0 Mar 17, 2022

#266 in Visualization

Apache-2.0

12KB
293 lines

esquel

Create mermaid diagrams from SQL scripts.

USAGE:
    esquel [OPTIONS] --input <INPUT>

OPTIONS:
    -d, --dialect <DIALECT>    [default: generic] [possible values: ansi, clickhouse, generic, hive,
                               mssql, mysql, postgres, sqlite, snowflake]
    -f, --flow <FLOW>          Direction of the flowchart [default: tb] [possible values: tb, bt,
                               rl, lr]
    -h, --help                 Print help information
    -i, --input <INPUT>        Path to sql script or raw sql
        --no-icons             Do not show icons
    -o, --out <OUT>            Path to output file
    -V, --version              Print version information

Uses all CREATE, INSERT, DELETE and UPDATE statements that reference other tables.

Example

The following SQL script

create table foo as
select * from bar;

create view baz as
select * from foo
inner join qux;

delete from foo
where exists (
  select 1 from qux
  where qux.foo_id = foo.foo_id
);

generates this flowchart:

graph TB
    A[bar]
    B[fa:fa-eye baz]
    C[fa:fa-table foo]
    D[qux]
    A --> C
    C --> B
    D --> B
    D --> C

Installation

cargo install esquel

Dependencies

~3.5MB
~72K SLoC