This page describes how to set up [Apache Superset](🔗) and configure it for use with Rockset.

These steps below require that you have installed the [rockset-sqlalchemy](🔗) package.

To install, run:

## Introduction

Superset is a data exploration and visualization web application. Refer [here](🔗) to set up Superset in your environment. Superset uses [SQLAlchemy](🔗) to perform operations.

## Configuration

  1. **Get credentials from Rockset.** Create and save an API Key using the [API Keys tab of the Rockset Console](🔗).

Create New API Key

  1. **Add Rockset as a data source.** To add Rockset as a Database source in Superset, navigate to `Sources > Databases` and click on the plus (`+`) symbol.

Superset add Database

  1. **Configure database.** Configure the database as follows:

  • Fill in the database name.

  • Use the format below for the SQLAlchemy URI. Replace `{api key}` with the your Rockset API key from Step 1 and `{region api endpoint}` with the host name from one of the region-specific URLs in the [Rockset API reference](🔗). To target a specific [<<glossary:Virtual Instance>>](🔗), replace `{virtual instance}` with its ID or RNN. To use the default instance, leave `{virtual instance}` empty.

Do not include the `https://` portion of the region-specific URL.

  • Select `Expose in SQL Lab`.

  • Select `Allow DML` if you want to run `DESCRIBE` queries on your [<<glossary:Collection>>](🔗).

  1. **Test connection.** Test the connection and if everything is successful, click `Save`.

Superset add Rockset

## Usage

  1. **Add Rockset collections.** Navigate to `SQL Lab > SQL Editor`. Select the Rockset Database added in the previous steps and select the 'commons' schema. This will populate the table schemas. Select the collection you want to run query on.

Superset SQL Lab

  1. **Visualize.** Click on `Explore` to visualize and create dashboards over the query results.

Superset Explore Results

  1. **View Results.** Navigate to `Sources > Tables` to add Rockset collections as a `Table` source. Once you're happy with how it looks, save and view your application!