open-index/open-npm huggingface dataset:
npm package: @tableau/query-graphs
Description: Helping people see and understand queries.
Author: Rick Cole
Latest version: 2.0.1

Query Graphs
============
[![Community Supported](https://img.shields.io/badge/Support%20Level-Community%20Supported-457387.svg)](https://www.tableau.com/support-levels-it-and-developer-tools)

Helping people see and understand queries.

![Query Visualization](https://tableau.github.io/query-graphs/standalone-server/media/sample_graph.png "Sample Graph")

Description
-----------

Query Graphs is an investigation into graph visualization for query processing, such as for logical queries and their physical
query evaluation plans.
Current visualizations are tailored for artifacts from Tableau's query ecosystem:
LogicalQuery XML, QueryFunction XML, and Hyper query-plan JSON.

This package provides the reusable core functionality, i.e. the loading and rendering of query plans.
As an end-user, you probably want to use QueryGraphs through one of the following applications:
* The [standalone server](standalone-server/) allows you to upload & visualize query plans
* The [JupyterLab extension](jupyterlab-extension/) integrates query plan visualization into [JupyterLab](https://github.com/jupyterlab/jupyterlab/)
* The [Tableau Log Viewer](https://github.com/tableau/tableau-log-viewer) can visualize query plans embeded into Tableau & Hyper log files

Development
-----------

Since this package only contains the core logic, it doesn't contain any
concrete way to actually trigger the visualization of a query plan.
For iterating on plan visualizations, we recommend to use the
[standalone server](../standalone-server) for testing and debugging the
visualization of query plans.

We do have some automated test coverage which can be tested through
`npm run test`. However, this test coverage is still spotty. Hence,
you should manually check if all examples included in the standalone-server
still work as expected.

We use eslint to lint our JavaScript code.
To run eslint on the appropriate files, you can use `npm run lint` inside this directory.
npm package: @tableau/query-graphs-jupyterlab-extension
Description: A JupyterLab extension for rendering query plans using the QueryGraphs viewer.
Author: Adrian Vogelsgesang
Latest version: 0.1.0

Query Graphs JupyterLab extension
============
[![Community Supported](https://img.shields.io/badge/Support%20Level-Community%20Supported-457387.svg)](https://www.tableau.com/support-levels-it-and-developer-tools)

A JupyterLab extension helping people see and understand queries.

![Screenshot of the JupyterLab extension in action](https://tableau.github.io/query-graphs/jupyterlab-extension/media/jupyterlab-screenshot.png)


## Prerequisites

* JupyterLab

## Installation

```bash
jupyter labextension install @tableau/query-graphs-jupyterlab-extension
```

## Development

For a development install of this extension, do the following in the this directory:

```bash
npm install
jupyter labextension link .
```

To rebuild the package and the JupyterLab app:

```bash
npm run build
jupyter lab build
```

By default, the JupyterLab extension picks up the version of `query-graphs` which was
officially released and published to the npm registry.
If you want to pull in changes from an unpublished version, e.g. during testing
your newly added improvements, you can either
* use `jupyter labextension link` to temporarily link the unpublished version of the query-graphs library into JupyterLab, or
* replace the `"@tableau/query-graphs": "^2.0.0"` dependency in the package.json by `"@tableau/query-graphs": "file:/absolute/path/to/query-graphs/query-graphs"`. Note that a relative path won't work.