Using Superset with Hydrolix

Superset is a data visualization platform that integrates easily with Hydrolix. After installing a database driver that supports Hydrolix’s query engine, you can use Superset to query, visualize, and analyze your Hydrolix-stored data.

This guide will show you how to start using your Hydrolix stack as a Superset datasource. It assumes that you have direct command-line access to the machine (or cloud instance) running your copy of Superset, and that you have fluency in running command-line programs.

Preparing your environment

First, and if you haven’t already done so, install Superset onto your machine or cloud instance using any of the methods described in Superset’s own documentation.

Then, install the latest version of Clickhouse’s SQLAlchemy driver, which includes the SSL support that Hydrolix connections require. To do this, use the pip package manager to install the driver directly from GitHub:

pip install git+https://github.com/cloudflare/sqlalchemy-clickhouse

Note that you should modify that command as needed so that the driver gets installed using the same Python executable and library collection that your machine’s Superset installation uses. If you installed Superset within a certain Python venv environment, for example, then you must install this driver within that same environment.

Once you have installed the Clickhouse SQLAlchemy driver, launch or restart your Superset instance.

Connecting Superset to Hydrolix

To connect Superset to your Hydrolix stack, select Data > Databases from Superset’s menu bar, then click +Database on the resulting page.

In the dialog box that appears, give your new Hydrolix-based database any name you wish, and then provide a URL in the following pattern:

clickhouse://YOUR-HYDROLIX-HOSTNAME.hydrolix.live:8443/YOUR-HYDROLIX-PROJECT?ssl=true

For example, if your Hydrolix stack’s hostname is example.hydrolix.live, and the Hydrolix project you’d like to connect with Superset is named my-project, then you’d provide this URL:

clickhouse://example.hydrolix.live:8443/my-project?ssl=true

Adding a new Superset database

To check that Superset can connect to your Hydrolix project over the internet, click Test Connection within the dialog. After a brief pause, the message “Connection looks good!” should appear.

If you see an error message instead, double-check the URI you have entered and try again. If you still find yourself unable to establish a connection here, please contact Hydrolix support.

Working with your data in Superset

Once Superset recognizes your Hydrolix stack as a datasource, you can use it to power every Superset feature from simple SQL queries to complex visualizations.

To do this, when setting up a new query or dataset within Superset, select your Hydrolix-based database as its datasource:

Selecting a Hydrolix-based datasource

Note that Superset attaches the label clickhouse to the name you chose for your Hydrolix datasource. This references the Clickhouse SQL driver that Superset uses to communicate wth Hydrolix’s query engine.

Getting more help

If you need more help with having your Superset and Hydrolix installations working together, or you’d just like to learn more about this integration, please contact Hydrolix support.