Apache Superset

Apache Superset is an open-source software application for data exploration and data visualization that can handle data at petabyte scale.

Prerequisites

Basic:

An active ByteHouse account with API token

Recommended:

Python version 3.8 or higher

Install ByteHouse Superset

Clone superset github repository

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

Go to the superset directory

cd superset

Create local requirements docker file

touch ./docker/requirements-local.txt

Add the bytehouse-sqlalchemy connector to the local requirements

echo "bytehouse-sqlalchemy" >> ./docker/requirements-local.txt

Build and run the superset docker container

docker-compose -f docker-compose-non-dev.yml pull
docker-compose -f docker-compose-non-dev.yml up

Connect to ByteHouse

After Superset docker container is built and running, you can use http://localhost:8088/superset/welcome/ to access the Superset UI. By default: Username "admin", Password "admin".
On the top right, go to + dropdown -> Data -> Connect database

From SUPPORTED DATABASES dropdown, choose Other

Fill DISPLAY NAME with any name that you want to assign to your database. Here database means Superset database alias which points to external datasource. Duplicate DISPLAY NAME is not allowed.
Fill SQLALCHEMY URL with bytehouse-connection-uri

region, api_key, database
region, account, user, password, database

// API Key Format
"bytehouse:///?region=$REGION&api_key=$API_KEY&database=$DATABASE"

// API Key Example
"bytehouse:///?region=AP-SOUTHEAST-1&api_key=0x12dKWPk6KwN8&database=test"


// Account, Username, Password Format
bytehouse:///?region=$REGION&account=$ACCOUNT&user=$USER&password=$PASSWORD&database=$DATABASE

// Account, Username, Password example
bytehouse:///?region=AP-SOUTHEAST-1&account=AWSAR17G&user=abc.mazu&password=ABCDE123&database=covid19