Apache Superset and Preset

You can use Superset or Preset, a cloud service for Superset, to query and visualize data.

Supported Versions

• Superset 1.0 and later
• Dremio SQLAlchemy connector 3.0.0 and later

Supported Authentication Method

Use a personal access token (PAT) obtained from a Dremio project. To create a PAT, follow the steps in the section Creating PATs.

Prerequisites

If you installed Superset according to the instructions for installing from scratch, install the Dremio SQLAlchemy Connector on the system or in the VM where Apache Superset is running. Instructions are in the sqlalchemy_dremio repository in GitHub.

Creating a Connection

1. Follow either of these steps:

   • If you are using Superset, follow these steps:

     1. Select Data > Databases in the menu bar at the top of the screen.

     2. Click the Database button in the top-right corner of the screen.

     3. In the Connect a Database dialog, select Other from the Supported Databases field.

     4. In the Display Name field, name the new connection.

   • If you are using Preset, follow these steps:

     1. Click the + icon in the top-right corner, and select Data > Connect Database.

     2. Select Dremio from the Supported Databases field of the Connect a Database dialog.

     3. (Optional) In the Display Name field, change Dremio to any name you prefer.

2. In the SQLALCHEMY URI field, specify a URI that in either of these formats. Use an ampersand in front of each additional parameter that you add.

   • If you want to authenticate to Dremio by using a username and password, specify a URI that is in this format:

     {{< codeheader "URI for username and password authentication" >}}

     dremio+flight://[<username>:`<password>`@]host:port/<schema>?UseEncryption=value&option1=value

   • If you want to authenticate to Dremio by using a PAT, specify a URI that is in this format:

     {{< codeheader "URI for personal access token (PAT) authentication" >}}

     dremio+flight://[<username>:<PAT>@]host:port/<schema>?UseEncryption=value&option1=value

3. Test the connection. If the test fails, check the syntax and values in the connection URI.

4. Click Connect.

Primary Connection Parameters

Name	Type	Description	Default Value	Required?
username	string	The username of the Dremio account to use	N/A	Yes, if you are not using a PAT to authenticate
password	string	The password of the Dremio account to use	N/A	Yes, if you are not using a PAT to authenticate
schema	string	The name of the database schema to use by default when a schema is not given in a query. However, this does not prevent queries from being issued for other schemas. Such queries must explicitly include the schema.	N/A	No
PAT	string	Specifies the personal access token (PAT) to use. Ensure that you URL-encode any PAT that you use. See Personal Access Tokens for the steps for creating a token.	N/A	Yes, if you are not using a username and password to authenticate

SSL connection parameters

Use the following parameters to configure SSL encryption and verification methods:

Name	Type	Description	Default Value
UseEncryption	integer	Forces the client to use an SSL-encrypted connection to communicate with Dremio. Accepted values include: true: The client communicates with Dremio by using SSL encryption. false: The client does not communicate with Dremio by using SSL encryption.	true
disableCertificateVerification	integer	Specifies whether the driver should verify the host certificate against the trust store. Accepted values are: false: The driver verifies the certificate against the trust store. true: The driver does not verify the certificate against the trust store.	false
trustedCerts	string	The full path of the .pem file containing certificates trusted by a CA, for the purpose of verifying the server. If this option is not set, then the driver defaults to using the trusted CA certificates .pem file installed by the driver. The exact file path varies according to the operating system on which the driver is installed. The path for the Windows driver is different from the path set for the macOS driver. The TLS connection fails if you do not specify a value when UseEncryption is true and disableCertificateVerification is false.	N/A

Advanced Parameters

Name	Type	Description	Default Value	Required?
routing_queue	string	Specifies the queue to route queries to during a session. Direct Routing is used to specify the exact queue and execution cluster to run queries on for a given ODBC session. With Direct Routing, workload-management (WLM) rules are not considered; instead, queries are routed directly to the specified queue. For more information, see Workload Management.	N/A
routing_tag	string	When this parameter is set, the specified tag is associated with all queries executed within a session. Rules can check for the presence of a tag with the function "tag()". For more information, see Workload Management.	N/A