Connect Superset to StarTree Cloud

To connect Superset to StarTree Cloud, do the following:

1. Install prerequisites
2. Obtain your Pinot API token, username, and password
3. Obtain your Pinot broker and controller URL
4. Format your SQLAlchemy URI
5. Add the SQLAlchemy URI in Superset

Prerequisites

• Have a running Pinot cluster. Sign up for a StarTree Cloud trial (opens in a new tab) to get up and running on Pinot.
• Have a running Superset instance. For more information about how install and deploy Superset, see What is Apache Superset? (opens in a new tab).
• Make sure your Superset instance has the Pinot database driver installed, which is compatible with StarTree Cloud. For more information, see how to install a database driver for Superset (opens in a new tab).

Obtain your API token, username, and password

To obtain your API token, see Generate an API token, and then to convert your API token to a username and password, see the Superset and Trino users section on the same page.

Obtain your Pinot broker and controller URL

1. In StarTree Cloud, go to Data Manager.
2. In the navigation menu, click Connections.
3. Select the demo connection, and then copy the values for server.broker-external-url and server.controller-external-url.

Format your SQLAlchemy URI

1. Encode the Pinot controller URL in UTF-8 format using urlencoder.org (opens in a new tab) or similar site.
2. Use the encoded UTF-8 format in the SQLAlchemy URI. See the following example for the correct SQLAlchemy URL format:

Example

• username is user
• password is pass
• broker url is https://broker.pinot.example:443
• controller url is https://controller.pinot.example:443

The url is pinot+https://user:pass@broker.pinot.example:443/query/sql?controller=https%3A%2F%2Fcontroller.pinot.example%3A443/verify_ssl=true 2. Use urlencoder.org (opens in a new tab) or a similar site to encode the Pinot controller URL as a UTF-8 character set.

Add the SQLAlchemy URI in Superset

1. In Superset, click + in the top right, and then select the Connect a database option.
2. Select Apache Pinot (if not in the list, see instructions in Prerequisites to download the Pinot database driver).
3. Paste the SQLAlchemy URI.