Superset
What is Superset
Apache Superset is an open-source software application for data exploration and data visualization able to handle data at petabyte scale.
Prerequisite
Basic requirements
- Installed Superset
- Have an active Bytehouse account with API token (Refer to previous document on steps to obtain API token)
Recommended requirements - Python version >= 3.8
Installing ByteHouse connector
- Reach out to ByteHouse support team for the links to install ByteHouse Connector
- Move these files to the superset/docker/ directory
- Add the driver & sqlalchemy to the local requirements
echo "./docker/bytehouse-driver-0.2.3.tar.gz" >> ./docker/requirements-local.txt
echo "./docker/bytehouse-sqlalchemy-0.2.4.tar.gz" >> ./docker/requirements-local.txt
Connecting to ByteHouse
- 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
-
After superset-docker-container has been built and running, you can use http://localhost:8088/superset/welcome/ to access the Superset UI
-
On the top right, go to + dropdown -> Data -> Connect database
- From SUPPORTED DATABASES dropdown, select Other

-
Fill DISPLAY NAME with any name that you want to assign for database. Here database means Superset database alias which points to external datasource. Duplicate DISPLAY NAME is not allowed.
-
Fill SQLACHEMY URI 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
Updated 20 days ago