sanpii/explain

Transform postgresql explain to a graph

Explain

Transform postgresql explain to a graph.

Install

If you use Arch Linux, explain is available in AUR.

Manually

git clone https://github.com/sanpii/explain
cd explain
make
sudo make install

Launch

Launch this program like psql and use dot to generate image:

$ explain --command 'select 1' database | dot -Tpng > explain.png

$ explain --help
explain 1.0.0

USAGE:
    explain [FLAGS] [OPTIONS] [dbname]

FLAGS:
        --analyse     this option executes explain analyse /!\ Be carful, that executes the query!
    -n, --dry-run     Don’t execute the query, the input is already an explain plan in JSON
        --help        Prints help information
    -W, --password    Prompt for a password before connecting to a database
    -V, --version     Prints version information

OPTIONS:
    -c, --command <command>    Specifies the command to execute
    -f, --file <file>          Read commands from the file, rather than standard input
    -h, --host <host>          Specifies the host name of the machine on which the server is running
    -o, --output <output>      Put output into file
    -p, --port <port>          Specifies the TCP port on which the server is listening for connections
    -U, --user <user>          Connect to the database as the user

ARGS:
    <dbname>    Specifies the name of the database to connect to

explain's Issues

Accept postgres urls as dbname

Elephantry accepts urls like postgres://user:password@host:port/dbname as connetion strings.
explain should also accept these.

Negative cost

In plan 3, cost of the 2nd node "append" is -0.01.

Generate from Query Plan

Hi @sanpii, thanks for such interesting project.

Does the CLI accept query plan text file, something similar to https://explain.depesz.com ?

For production environments, we may only obtain the query plan without direct database access.

Thanks.

Display CTE

przygienda/dot-rust#8

Support escapted characteres in .pgpass

    #[test]
    fn parse_escape() {
        let pgpass = PgPass::from_str("local\\:host:*:post\\\\gres:*:1234");

        assert_eq!(Some("1234".to_string()), pgpass.find("local:host", 5432, "post\\gres", "postgres"));
    }

Improve long node display

Negative time percent

In plan 4 the top level time percent is -89%