QPML is a utility for visualizing query plans, intended to help produce documentation and presentations.
Query plan diagrams can easily be hand-coded in the YAML-based Query Plan Markup Language, or can be imported from Substrait query plans, or from text representations of query plans, as displayed by an EXPLAIN command.
Here is a minimal example of a QPML file. See examples/nested-join.yaml for a fuller example.
diagram:
title: 'Inner Join: w_warehouse_sk = inv_warehouse_sk'
style: join
inputs:
- title: 'Inner Join: cs_item_sk = inv_item_sk'
style: join
inputs:
- title: catalog_sales
style: table
- title: inventory
style: table
- title: warehouse
style: table
styles:
- name: table
color: lightblue
shape: rectangle
- name: join
color: lightgreen
shape: rectangleqpml dot minimal.qpml > minimal.dot
dot -Tpng minimal.dot > minimal.png
$ qpml mermaid minimal.qpml > minmal.mdflowchart TD
node0[Inner Join: w_warehouse_sk = inv_warehouse_sk] --> node0_0[Inner Join: cs_item_sk = inv_item_sk]
node0_0[Inner Join: cs_item_sk = inv_item_sk] --> node0_0_0[catalog_sales]
node0_0[Inner Join: cs_item_sk = inv_item_sk] --> node0_0_1[inventory]
node0[Inner Join: w_warehouse_sk = inv_warehouse_sk] --> node0_1[warehouse]
$ qpml print minimal.qpmlInner Join: w_warehouse_sk = inv_warehouse_sk
Inner Join: cs_item_sk = inv_item_sk
catalog_sales
inventory
warehouse
See the QPML Documentation for more information.