Superset

Apache Superset is a popular open-source business intelligence web application that enables users to visualize and explore data through customizable dashboards and reports.

QuestDB provides the QuestDB Connect python package that implements the SQLAlchemy dialect and Superset engine specification, to integrate Apache Superset with QuestDB.

We recommend the Docker-based Apache Superset installation. You will need to install the following requirements:

  • Docker, including Docker Compose
  • QuestDB 7.1.2 or later

Then, following the steps below:

  1. Clone the Superset repo:

    git clone https://github.com/apache/superset.git

  2. Change your directory:

    cd superset

  3. Create a file docker/requirements-local.txt with the requirement to questdb-connect:

    touch ./docker/requirements-local.txt
    echo "questdb-connect==1.1.3" > docker/requirements-local.txt

  4. Set Superset version to 4.0.2: This step is important to ensure compatibility with QuestDB Connect.

    export TAG=4.0.2

  5. Run Apache Superset:

    docker compose -f docker-compose-image-tag.yml pull
    docker compose -f docker-compose-image-tag.yml up

    This step will initialize your Apache Superset installation, creating a default admin, users, and several other settings. The first time you start Apache Superset it can take a few minutes until it is completely initialized. Please keep an eye on the console output to see when Apache Superset is ready to be used.

Installing Superset via QuestDB Connect​

If you have a stand-alone installation of Apache Superset and are using Apache Superset without Docker, you need to install the following requirements :

  • Python from 3.9 to 3.11
  • Superset 4.0.x
  • QuestDB 7.1.2 or later

Install QuestDB Connect using pip:

pip install 'questdb-connect==1.1.3'

Connecting QuestDB to Superset​

Once installed and initialized, Apache Superset is accessible via localhost:8088.

  1. Sign in with the following details:

    • Username: admin
    • Password: admin

  2. From Superset UI, select Setting > Database Connections

  3. Select +Database to add a new QuestDB database

    QuestDB Database Selection

  4. In the next step use host.docker.internal when running Apache Superset from Docker and localhost for outside of Docker. Port is 8812 by default, and the database name is QuestDB, default user is admin and password is quest.

    QuestDB Database Configuration

  5. Once connected, tables in QuestDB will be visible for creating Datasets in Apache Superset.

    QuestDB Tables in Superset

Conclusion​

The integration of Apache Superset with QuestDB allows users to visualize and explore data through customizable dashboards and reports. This guide provides instructions for installing Apache Superset via Docker and QuestDB Connect, and connecting QuestDB to Apache Superset.

If you have any questions or need help, please join our community Slack or open a GitHub issue.

See also​