Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tableau/query-graphs
A visualizer for queries - Hyper, Postgres, Tableau
https://github.com/tableau/query-graphs
database postgres postgresql query-optimization visualization
Last synced: 3 months ago
JSON representation
A visualizer for queries - Hyper, Postgres, Tableau
- Host: GitHub
- URL: https://github.com/tableau/query-graphs
- Owner: tableau
- License: mit
- Created: 2016-10-25T18:23:12.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T22:39:03.000Z (5 months ago)
- Last Synced: 2024-07-19T10:33:58.063Z (4 months ago)
- Topics: database, postgres, postgresql, query-optimization, visualization
- Language: TypeScript
- Homepage: https://tableau.github.io/query-graphs/
- Size: 15.8 MB
- Stars: 84
- Watchers: 10
- Forks: 27
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Query Graphs
============
[](https://www.tableau.com/support-levels-it-and-developer-tools)
Helping people see and understand queries - [Visualize your own query!](http://tableau.github.io/query-graphs/index.html)
[
](https://tableau.github.io/query-graphs/index.html?file=examples%2Fhyper%2Ftpch%2Ftpch-q19-analyze.plan.json&title=tpch-q19-analyze.plan.json)
[
](https://tableau.github.io/query-graphs/index.html?file=examples%2Fhyper%2Ftpch%2Ftpch-q2-analyze.plan.json&title=tpch-q2-analyze.plan.json)
Description
-----------
"Query graphs" visualizes query plans for PostgresQL, Hyper or Tableau logical queries and can easily be extended for other database systems.
Query graphs is based on the experience of Tableau and the Hyper team with debugging complex OLAP queries.
In contrast to many competing plan visualizers, query graphs:
* visualizes large and complex query plans without presenting an overwhelming amount of information,
* immediately draws your attention to tne most critical parts of the query plan through proper color coding,
* allows you to drill down on the interesting parts of the query-plan, e.g., by expanding more details by clicking on the node of interest,
* supports multiple different plan types (currently Postgres, Hyper and PostgresQL),
* can be easily embeded into larger tools,
* works fully offline and can be installed as a "web app" from your browser.
For a first impression see our [list of example visualizations](https://tableau.github.io/query-graphs/examples.html), a few particularly examples are:
* [PostgreSQL TPC-H Query 2](https://tableau.github.io/query-graphs/index.html?file=examples%2Fpostgres%2Ftpch%2Ftpch-q2-analyze.plan.json&title=tpch-q2-analyze.plan.json)
* [Hyper TPC-H Query 2](https://tableau.github.io/query-graphs/index.html?file=examples%2Fhyper%2Ftpch%2Ftpch-q2-analyze.plan.json&title=tpch-q2-analyze.plan.json)
* [Optimizer steps of Hyper for TPC-H Q2](https://tableau.github.io/query-graphs/index.html?file=examples%2Fhyper%2Ftpch%2Ftpch-q2-steps.plan.json&title=tpch-q2-steps.plan.json)
Installation
------------
You can use https://tableau.github.io/query-graphs/, you do not need to install anything.
If you still need a local deployment, see the [Developer instructions](DEVELOPMENT.md) for instructions.
Usage
-----
1. Go to https://tableau.github.io/query-graphs/
2. Open your query plan, e.g. by copy pasting
3. Visually explore the query plan
Note that we never upload your query plan.
All processing happens directly inside your browser.
The query plans never leave your machine - we value your privacy ;)
Supported query plan formats:
* Postgres' JSON format, obtained by `EXPLAIN (FORMAT JSON)`. Particularly interesting if used in combination with `EXPLAIN(ANALYZE, FORMAT JSON)`
* Hyper's query plans. You can run Hyper (the database system powering Tableau) locally through HyperAPI, and send Hyper `EXPLAIN (VERBOSE)` queries to obtain query plans. See [dump-plans.py](plan-dumper/dump-plans.py) for an example.
* Tableau logical queries. Can be obtained from the log files of Tableau Desktop or Tableau Online.
Contributing
------------
Pull requests welcome!
In particular, we would be happy about support for additional query plan formats from additional database systems.
New core functionality is also welcome, but you might want to open a GitHub issue first and get some feedback, before spending considerable amounts of time on cool new features.
To get started hacking on query graphs, see [DEVELOPMENT.md](DEVELOPMENT.md).
Acknowledgements
----------------
Query Graphs uses the amazing [react-flow](https://reactflow.dev/) library for rendering. For layouting the query plan, we use [d3-flextree](https://github.com/Klortho/d3-flextree).