Apache Superset

You can use Superset to query and visualize data.

Supported Versions

• Superset 1.5.3 and later
• Dremio SQLAlchemy connector 3.0.2 and later

Supported Authentication Methods

• Use the username and password of an account in your Dremio cluster.
• Use the username of an account in your Dremio cluster and a personal access token (PAT) created in Dremio. To create a PAT, follow the steps in Creating a PAT. After you obtain a PAT, it is recommended that you URL-encode it. To encode it locally on your system, you can follow these steps:
  1. In a browser window, right-click an empty area of the page and select Inspect or Inspect Element, depending on your browser.
  2. In the top bar of the inspection pane, click Console.
  3. Type encodeURIComponent("<PAT>"), where <PAT> is the personal access token. The URL-encoded PAT appears in red on the next line. You can highlight it and copy it to your clipboard.

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. If you are using a version of Superset earlier than 2.1.0, 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.
2. If you are using version 2.1.0 or later of Superset, follow these steps:
   1. Click Datasets in the menu bar at the top of the screen.
   2. Click the plus (+) icon in the top-right corner.
   3. Select Data > Connect database.
3. In the Connect a Database dialog, follow these steps:

   1. Select Other from the Supported Databases field.

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

   3. If you want to authenticate by using a username and password, specify in the SQLAlchemy URI field a URI that is in this format: Format of URIs with username and password authentication

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

       

      • <username>: The username of the Dremio account to use.
      • <password>: The password of the Dremio account to use.
      • <host>: The hostname or IP address of the coordinator node of the Dremio cluster.
      • <port>: The port to connect to on the coordinator node. Unless explicitly changed on the node, the port is 32010.
      • <schema>: The name of the database schema to use by default when a schema is not given in a query. Providing a schema is optional. Specifying a schema does not prevent queries from being issued for other schemas; such queries must explicitly include the schema.
      • [?option1=value[&,...]]: One or more optional properties, separated by ampersands (&). See SSL Connection Properties and Advanced Properties.
      Example URI with username and password authentication

      dremio+flight://myUserID:myPassword@myHost:32010/Samples?UseEncryption=false

       

   4. If you want to authenticate by using a personal access token, specify in the SQLAlchemy URI field a URI that is in this format: Format of URIs with PAT authentication

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

       

      • <username>: The username of the Dremio account to use.
      • <PAT>: The URL-encoded personal access token that you obtained from Dremio Cloud. See Supported Authentication Methods.
      • <host>: The hostname or IP address of the coordinator node of the Dremio cluster.
      • <port>: The port to connect to on the coordinator node. Unless explicitly changed on the node, the port is 32010.
      • <schema>: The name of the database schema to use by default when a schema is not given in a query. Providing a schema is optional. Specifying a schema does not prevent queries from being issued for other schemas; such queries must explicitly include the schema.
      • [?option=value[;...]]: One or more optional properties, separated by semicolons. See SSL Connection Properties and Advanced Properties.
      Example URI with PAT authentication

      dremio+flight://myUserID:myPAT@myHost:32010/Samples?UseEncryption=false

       

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

   6. Click Connect.

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: 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 to verify the host certificate against the trust store. Accepted values: false, verifies the certificate against the trust store; true, 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, defaults to using the trusted CA certificates .pem file. 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
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