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 quickest way to try Superset locally. Upstream states it does not support or recommend the docker compose constructs for production use, so treat this path as evaluation only. 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
SQLAlchemy version

greptimedb-sqlalchemy requires sqlalchemy>=1.4,<2. Superset 6.1.0, the current release, pins SQLAlchemy 1.4.54 and works with it. Superset's main branch has moved to SQLAlchemy 2.0, so a later release will need a dialect that supports 2.0 first. If you run an older Superset, check its own SQLAlchemy pin against that range.

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.