Apache Superset

Apache Superset is a modern data exploration and visualization platform. This article explains how to create visualizations using data stored in YDB.

Installation of dependencies

To connect to YDB from Superset, install the ydb-sqlalchemy driver.

The installation method depends on your Superset setup. For detailed instructions, see the official documentation.

Adding a database connection to YDB

There are two ways to connect to YDB:

1. Native connection using the SQLAlchemy driver (starting from version 5.0.0)
2. Connect using the PostgreSQL wire protocol

It is recommended to use a native connection whenever possible.

Native connection using SQLAlchemy driver

To connect to YDB from Apache Superset version 5.0.0 and higher, follow these steps:

1. In the Apache Superset toolbar, hover over Settings and select Database Connections.

2. Click the + DATABASE button.

   The Connect a database wizard will appear.

3. In Step 1 of the wizard, choose YDB from the Supported databases list. If the YDB option is not available, make sure that all the steps from prerequisites are completed.

4. In Step 2 of the wizard, enter the YDB credentials in the corresponding fields:

   • Display Name. The YDB connection name in Apache Superset.
   • SQLAlchemy URI. A string in the format ydb://{host}:{port}/{database_name}, where host and port are parts of the endpoint of the YDB cluster to which the connection will be made, and database_name is the path to the database.

   

5. To enhance security, you can specify credentials parameters in the Secure Extra field under the Advanced / Security tab.

   Define the parameters as follows:

   Password

   Access Token

   Service Account

   {
       "credentials": {
           "username": "...",
           "password": "..."
       }
   }
   

   {
       "credentials": {
           "token": "...",
       }
   }
   

   {
       "credentials": {
           "service_account_json": {
               "id": "...",
               "service_account_id": "...",
               "created_at": "...",
               "key_algorithm": "...",
               "public_key": "...",
               "private_key": "..."
           }
       }
   }
   

6. Click CONNECT.

7. To save the database connection, click FINISH.

For more information about configuring a YDB connection, refer to the YDB section in the official documentation.

Connect using the PostgreSQL wire protocol

To connect to YDB from Apache Superset using the PostgreSQL wire protocol, follow these steps:

1. In the Apache Superset toolbar, hover over Settings and select Database Connections.

2. Click the + DATABASE button.

   The Connect a database wizard will appear.

3. In Step 1 of the wizard, click the PostgreSQL button.

4. In Step 2 of the wizard, enter the YDB credentials in the corresponding fields:

   • HOST. The endpoint of the YDB cluster to connect to.
   • PORT. The port of the YDB endpoint.
   • DATABASE NAME. The path to the database in the YDB cluster where queries will be executed.
   • USERNAME. The login for connecting to the YDB database.
   • PASSWORD. The password for connecting to the YDB database.
   • DISPLAY NAME. The YDB connection name in Apache Superset.

   

5. Click CONNECT.

6. To save the database connection, click FINISH.

Creating a dataset

To create a dataset for a YDB table, follow these steps:

1. In the Apache Superset toolbar, hover over the + button and select SQL query.

2. In the DATABASE drop-down list, select the YDB database connection.

3. Enter the SQL query in the right section of the page. For example, SELECT * FROM <ydb_table_name>.

   Tip

   To create a dataset for a table located in a subdirectory of a YDB database, specify the table path in the table name. For example:

   SELECT * FROM "<path/to/subdirectory/table_name>";