Apache Superset is an open-source data exploration and data visualization software application. As a database, RisingWave can act as a data source for Business Intelligence tools like Apache Superset.
This guide will go over how to:
- Connect RisingWave to Superset.
- Create a dashboard.
Install and start RisingWave
To install and start RisingWave locally, see the Get started guide. We recommend running RisingWave locally for demo purposes.
Connect to a streaming source. For details on connecting to streaming sources and what sources are supported with RisingWave, see CREATE SOURCE.
Install Apache Superset
To install Apache Superset, follow the instructions in Installing locally using Docker Compose. This guide will cover how to install the database driver in Docker, so we recommend installing it using Docker Compose.
Establish the connection between Superset and RisingWave
Add the sqlalchemy-risingwave driver
#From the repo root...
Add the driver selected in the step above.
echo "sqlalchemy-risingwave" >> ./docker/requirements-local.txt
Rebuild your local image with the new driver.
docker-compose build --force-rm
Start Apache Superset
If it is your first time starting Superset and the webpage asks for a username and password, use
admin for both.
The following UI page should appear.
Connect to RisingWave
In Superset, select Settings > Database connections.
Click + Database.
In the window that pops up, under Supported databases, select Other from the dropdown menu.
Fill in the primary credentials with SQLALCHEMY URI as
Select Test Connection then Connect.
Create a dashboard
Create tables or materialized views in RisingWave
Instead of using Superset to create materialized views or tables, use RisingWave. For this guide, we will create the table
t and insert some data.
Once RisingWave starts, use the following queries to create the table
t and insert some values to the table.
CREATE TABLE t (v float, ts timestamp);
INSERT INTO t VALUES (1.0, '2022-11-15 15:35:40'),
(2.1, '2022-11-15 15:36:24'),
(3.5, '2022-11-15 15:37:32'),
(4.2, '2022-11-15 15:38:12'),
(4.2, '2022-11-15 15:38:21');
Create and export tables or materialized views
Export the data from materialized views or tables in RisingWave to Superset:
Select Datasets then + Dataset.
In the window that pops up, under Database, select RisingWave.
Under Schema, select the schema the table or materialized view was created in. By default, they are in the
Select the materialized view or table to be exported to Superset. In this guide, we'll select
Once the materialized view has been added as a dataset, it can be used to create dashboards.
Create a dashboard in Superset
To create a dashboard based on the table
Click Create chart.
Select Time-series line chart as the rendering method.
tsas the time column.
AVG(v)as the metric.
Click Update chart. The query results will be rendered into a line chart.
For more details on creating dashboards, see the Creating your first dashboard guide.