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.
Installing Apache Superset via Docker (recommended)
We recommend the Docker-based Apache Superset installation. You will need to install the following requirements:
- Docker
- QuestDB 7.1.2 or later
Then, following the steps below:
- Clone the Superset repo:
git clone https://github.com/apache/superset.git
-
Change your directory:
cd superset
-
Create a file
docker/requirements-local.txt
with the requirement toquestdb-connect
:
touch ./docker/requirements-local.txt
echo "questdb-connect==1.0.12" > docker/requirements-local.txt
-
Run Apache Superset:
docker-compose -f docker-compose-non-dev.yml pull
docker-compose -f docker-compose-non-dev.yml upThis 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
- QuestDB 7.1.2 or later
Install QuestDB Connect using pip
:
pip install 'questdb-connect==1.0.12'
Connecting QuestDB to Superset
Once installed and initialized, Apache Superset is accessible via localhost:8088.
- Sign in with the following details:
- Username: admin
- Password: admin
- From Superset UI, select Setting > Database Connections
- Select
+Database
to add the following parameters:- SUPPORTED DATABASES: Other
- DISPLAY NAME: QuestDB
- SQLALCHEMY URI:
questdb://admin:quest@host.docker.internal:8812/qdb
- For the
SQLALCHEMY URI
field, usehost.docker.internal
when running Apache Superset from Docker andlocalhost
for outside of Docker. - Once connected, tables in QuestDB will be visible for creating Datasets in Apache Superset.