spannerplanviz

README

spannerplanviz

Cloud Spanner Query Plan Visualizer using goccy/go-graphviz.

(Possibly) remote calls are rendered as dashed lines.

Install

$ go get -u github.com/apstndb/spannerplanviz

Usage

It can read various types in JSON and YAML.

• QueryPlan
  • Can get easily by client libraries
    • AnalyzeQuery()
    • RowIterator.QueryPlan
• ResultSetStats
  • Output of DOWNLOAD JSON in the official query plan visualizer
• ResultSet
  • Output of gcloud spanner databases execute-sql and execspansql

PROFILE

$ gcloud spanner databases execute-sql --instance=sampleinstance sampledb --query-mode=PROFILE --format=yaml \
  --sql "SELECT SongName FROM Songs" |
  spannerplanviz --full --type=svg --output profile.svg

PLAN

$ gcloud spanner databases execute-sql --instance=sampleinstance sampledb --query-mode=PLAN --format=yaml \
  --sql="SELECT SongName FROM Songs WHERE STARTS_WITH(SongName, @prefix)" |
  spannerplanviz --full --type=svg --output plan.svg

Disclaimer

This tool is PRE-ALPHA quality.