From 33fc8fa79769f2c47b62a5ac84fad2c6432db9fd Mon Sep 17 00:00:00 2001 From: ptiurin Date: Mon, 18 Dec 2023 11:02:48 +0000 Subject: [PATCH] Add Apache Superset integration guide --- .../connecting-to-apache-superset.md | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/Guides/integrations/connecting-to-apache-superset.md diff --git a/docs/Guides/integrations/connecting-to-apache-superset.md b/docs/Guides/integrations/connecting-to-apache-superset.md new file mode 100644 index 00000000..1da0f38d --- /dev/null +++ b/docs/Guides/integrations/connecting-to-apache-superset.md @@ -0,0 +1,36 @@ +--- +layout: default +title: Apache Superset +description: Learn about connecting Apache Superset to Firebolt. +nav_order: 5 +parent: Integrate with Firebolt +grand_parent: Guides +--- + +# Connecting to Apache Superset + +[Apache Superset](https://superset.apache.org) is a business intelligence web application that makes it easy for users of all skill sets to explore and visualize their data, from simple pie charts to highly detailed deck.gl geospatial charts. + +## To get started + +### Install the driver + +If you self-host Superset, you must install the Firebolt driver. + +To install the driver, see [Adding New Database Drivers in Docker](https://superset.apache.org/docs/databases/docker-add-drivers) in Superset documentation. Use `firebolt-sqlalchemy` as the driver name in `requirements-local.txt`. + +### Set up the connection + +In the Superset UI, go to **Data** > **Databases** > **Add Database**. + +The connection expects a SQLAlchemy connection string of the form: + +``` +firebolt://{client_id}:{client_secret}@{database}/{engine_name} +``` + +To authenticate, use a service account ID and secret. +A service account is identified by a `client_id` and a `client_secret`. +Learn how to generate an ID and secret [here](../managing-your-organization/service-accounts.md). + +This is currently available in the latest `master` branch in Superset and will also be included in the Superset v1.4 stable release when it is available.