Add DOT encoding support for internal/graph

kevinmingtarja commented 10 months ago

Description

This PR adds support for encoding the dependency graph to DOT format, which is used by Graphviz, a popular graph visualization software. This will allow us to visualize our dependency graphs for debugging purposes.

Motivation

Closes #38

Testing

Added a unit test for the function
Locally, I tested it against some schemas from the test suite and temporarily outputting the encoded graph in resolveToSQLGraph(), then manually visualized it using http://magjac.com/graphviz-visual-editor/ to verify the format's correctness

Example output:

I have a fresh new postgres instance and my target schema is this:

CREATE TABLE foobar(
    id INT,
    foo VARCHAR(255),
    bar TEXT,
    fizz INT,
    PRIMARY KEY (foo, id)
) PARTITION BY LIST (foo);
CREATE TABLE foobar_1 PARTITION OF foobar FOR VALUES IN ('foo_1');
CREATE TABLE foobar_2 PARTITION OF foobar FOR VALUES IN ('foo_2');
CREATE TABLE foobar_3 PARTITION OF foobar FOR VALUES IN ('foo_3');

Based on the diffs and dependency graph, The DOT encoding will output:

digraph G {
fontname="Helvetica,Arial,sans-serif"
node [fontname="Helvetica,Arial,sans-serif"]
edge [fontname="Helvetica,Arial,sans-serif"]
n0 [label="ADDALTER_table_foobar"]
n1 [label="ADDALTER_table_foobar_2"]
n2 [label="DELETE_table_foobar_2"]
n3 [label="ADDALTER_table_foobar_3"]
n4 [label="DELETE_table_foobar_3"]
n5 [label="DELETE_table_foobar"]
n6 [label="ADDALTER_table_foobar_1"]
n7 [label="DELETE_table_foobar_1"]
n0 -> n1
n0 -> n3
n0 -> n6
n2 -> n1
n4 -> n3
n5 -> n0
n7 -> n6
}