Connect Apache Superset to Hologres for visual data analytics - Hologres

Connect Apache Superset to Hologres to run queries and build dashboards on your Hologres data.

Apache Superset is an open-source business intelligence (BI) tool for data exploration and visual analytics, built with Python, Flask, Pandas, and SQLAlchemy. Because Hologres is PostgreSQL-compatible, Superset connects to it using the standard PostgreSQL driver.

Prerequisites

Before you begin, ensure that you have:

A Hologres instance. To create one, see Purchase a Hologres instance
Apache Superset installed. See the Apache Superset website for installation instructions

Step 1: Gather your connection details

Collect the following information before opening Superset. Having these values ready prevents you from interrupting the configuration midway.

Parameter	Where to find it
HOST	Log on to the Hologres console. In the left-side navigation pane, click Instances. Click the instance ID, then go to the Instance Details page. In the Network Information section, copy the endpoint.
PORT	Found in the same Network Information section as HOST.
DATABASE NAME	In the Hologres console, click Manage in the Actions column of your instance. Go to Database Management > Database Authorization to see the database name.
USERNAME	Your Alibaba Cloud AccessKey ID. Get it from AccessKey Management.
PASSWORD	Your Alibaba Cloud AccessKey secret.

Important

Select the endpoint that matches the network environment where Superset runs (public or VPC). Using the wrong endpoint type causes the connection to fail.

Step 2: Configure the database connection in Superset

This procedure uses Apache Superset V0.38.0 as an example. Steps may vary slightly in other versions.

Log on to Superset. In the top menu bar, choose Sources > Database Connections to go to the Databases page.
In the upper-right corner, click DATABASE to open the Connect a database page.
Select PostgreSQL.

Fill in the connection parameters using the values you gathered in Step 1.

Parameter	Description
HOST	The endpoint of your Hologres instance.
PORT	The port number of your Hologres instance.
DATABASE NAME	The name of the Hologres database to connect to.
USERNAME	Your Alibaba Cloud AccessKey ID.
PASSWORD	Your Alibaba Cloud AccessKey secret.
DISPLAY NAME	A display name for this database connection in Superset.
ADDITIONAL PARAMETERS	Set `application_name=superset` to identify queries from Superset in Hologres query logs.

Click FINISH. Superset validates the connection and saves the configuration. After the connection is saved, the database appears in the Databases list and is available as a data source for charts and dashboards.

What's next

Build charts and dashboards using the Hologres data source. See Apache Superset with PostgreSQL for details on using Superset with a PostgreSQL-compatible database.