Connecting from Apache Superset or Preset to Dremio Sonar
- 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 obtain one, follow the steps in the section Creating a Token. After you obtain a PAT, you must URL-encode it. To encode it locally on your system, you can follow these steps:
- In a browser window, right-click an empty area of the page and select Inspect or Inspect Element, depending on your browser.
- In the top bar of the inspection pane, click Console.
<PAT>is the personal access token that you obtained from Dremio Cloud. The URL-encoded PAT appears in red on the next line. You can highlight it and copy it to your clipboard.
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 this format. Use an ampersand in front of each additional parameter that you add:URI format
Test the connection. If the test fails, check the syntax and values in the connection URI.
Primary Connection Parameters
|<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. See Supported Authentication Method||N/A||Yes|
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_engine||string||The engine to route queries to while a connection remains open.||N/A||No|