Apache Superset and Preset
- 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 Sonar project. To create a PAT, follow the steps in the section Creating PATs.
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
Follow either of these steps:
If you are using Superset, follow these steps:
Select Data > Databases in the menu bar at the top of the screen.
Click the Database button in the top-right corner of the screen.
In the Connect a Database dialog, select Other from the Supported Databases field.
In the Display Name field, name the new connection.
If you are using Preset, follow these steps:
Click the + icon in the top-right corner, and select Data > Connect Database.
Select Dremio from the Supported Databases field of the Connect a Database dialog.
(Optional) In the Display Name field, change Dremio to any name you prefer.
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:
- If you want to authenticate to Dremio by using a PAT, specify a URI that is in this format:
Test the connection. If the test fails, check the syntax and values in the connection URI.
Primary Connection Parameters
|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|
|token||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:
|useEncryption||integer||Forces the client to use an SSL-encrypted connection to communicate with Sonar. Accepted values include:|
|disableCertificateVerification||integer||Specifies whether the driver should verify the host certificate against the trust store. Accepted values are:|
|trustedCerts||string||The full path of the |
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
|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.
|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|