Skip to main content
Version: nightly

Superset

Apache Superset is an open source BI tool that written in Python. To configure GreptimeDB as a database in Superset, you can follow this guide.

Installation​

Running Superset with Docker Compose​

Docker compose is the recommended way to run Superset. To add GreptimeDB extension, create a requirements-local.txt file in docker/ of Superset codebase.

Add GreptimeDB dependency in requirements-local.txt:

greptimedb-sqlalchemy

Start Superset services:

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

Running Superset Locally​

If you are running Superset from pypi, install our extension to the same environment.

pip install greptimedb-sqlalchemy

Add GreptimeDB as database​

To add GreptimeDB database, select Settings / Database Connections.

Add database and select GreptimeDB from list of supported databases.

Follow the SQLAlchemy URI pattern to provide your connection information:

greptimedb://<username>:<password>@<host>:<port>/<database>
  • Ignore <username>:<password>@ if you don't have authentication enabled.
  • Use 4003 for default port (this extension uses Postgres protocol).
  • Use public as default database. When using GreptimeCloud instance, use the database name from your instance.