[!WARNING]
Under construction!

Install

Using homebrew tap:

brew install gabotechs/taps/substrait-viz

Or with npm:

npm install -g substrait-viz

Usage

If the Substrait plan does not contain any reference to protobuf messages declared in other specifications besides the Substrait one, it's as simple as passing the file containing the Substrait payload in either JSON or binary format:

substrait-viz my-substrait-file.json

substrait-viz my-substrait-file.bin

If the Substrait plan contains reference to protobuf messages declared in external protobuf specifications, you'll need to build a descriptor set from those specifications and pass it as an argument.

substrait-viz my-substrait-file.json --descriptor my-custom-messages.binpb

Examples

This repo contains several plans that can be used for trying out the tool, for example all tcph plans in packages/SubstraitViz/src/.test_data/:

substrait-viz packages/SubstraitViz/src/.test_data/tpch-plan01.json