Tableau Prep Builder #
Tableau Prep Builder can connect to Starburst Galaxy or SEP to access your data.
There are three ways to connect Tableau Prep Builder a Starburst Enterprise platform (SEP) or Starburst Galaxy cluster:
Tableau data connector: The recommended connection method uses a Tableau data connector paired with the Starburst JDBC driver.
ODBC connection: Starburst supports connecting to clusters with the Starburst ODBC driver.
Legacy JDBC connection: Starburst continues to support the legacy connection method that uses a plain JDBC connection and the “Other Databases (JDBC)” entry point. Starburst strongly recommends migrating from this legacy method to the Tableau data connector method.
Before you begin #
For Starburst Galaxy clusters, use the Connection info pane to obtain the connection information.
Tableau data connector #
You can connect Tableau Prep Builder to Starburst Galaxy or SEP clusters with a combination of a Tableau data connector file and JDBC driver. This method requires:
- Starburst Galaxy or SEP 354-e or later
- Tableau Prep Builder 2020.4 or later
- Trino JDBC driver 386 or later
Note that a Tableau data connector is not the same as a data source connector in
SEP. The Tableau data connector is a software bridge between
Tableau and the standard Starburst JDBC driver. The two files work
together to enable access between Tableau and one or more Starburst Galaxy or
SEP clusters. The Tableau data connector is a JAR file with a
name similar to
Download data connector #
In Tableau Prep Builder, the Tableau data connector for Starburst Enterprise does not appear automatically in the list of Additional Connectors. To get Starburst Enterprise to appear in that list, follow these steps to manually download the Tableau data connector for Starburst Enterprise:
Close and exit Tableau Prep Builder.
From the Starburst Enterprise page of Tableau’s web-based Extension Gallery, download the Tableau data connector file whose name is similar to
StarburstEnterprise.taco. Use the Download button on the upper right of the page. This requires logging into Tableau’s site with a free login.
Move the data connector
.tacofile to the following location, depending on which operating system you are using:
Windows: C:\Users\username\Documents\My Tableau Prep Repository\Connectors
macOS: /Users/username/Documents/My Tableau Prep Repository/Connectors
Download the latest Trino JDBC driver.
Place the JDBC driver file in the following location, depending on which operating system you are using:
Windows: C:\Program Files\Tableau\Drivers
Do not store more than one Starburst JDBC driver in this directory. Delete any older drivers when you update to a newer version. Connections to all connected data sources are made through the JDBC driver.
Connect to Starburst #
To establish a connection to Starburst Galaxy or SEP, do the following:
Start Tableau Prep Builder. In the left-side blue panel, click to expose the Connections pane, then click the plus + sign to add a new connection.
In the list of server types, select Starburst Enterprise by Starburst. This opens a Connector Details dialog that describes the data connector.
Click Install. This opens a connection dialog:
Fill in the connection dialog with the following parameters:
Field Value Server Hostname or IP address of your cluster. Port Port used by your cluster. Authentication Use the drop-down list to select among four options: Username for a cluster with no authentication, Username and Password for a cluster with a password-based authentication method such as LDAP, or OAuth. If you select OAuth, see OAuth 2.0 authentication. Username Your username for Starburst Galaxy or SEP. Password (If selected) the password for the specified Username. Require SSL Select this checkbox if your cluster has any authentication enabled. When selected, the following field appears. SSL Verification Select an entry in the drop-down list to specify how rigorously the server’s certificate is to be validated.
The values for SSL Verification have the following meanings:
- Confirm that the certificate's validity is chained all the way back to a root Certificate Authority (CA).
- Confirm that the certificate is valid as far back as the included intermediate CA.
- Confirm that the server's certificate matches the DNS name and private key of the server.
When the connection is made, the Connections panel shows a list of the catalogs configured in your cluster.
To see the available tables, select a catalog, then a schema from that catalog.
Select a table, or select multiple tables and specify relationships or joins.
Configure an initial SQL query #
When using the Starburst data connector, best practice is to take advantage of the Initial SQL panel of the initial connection dialog.
Provide an initial SQL statement that is known to be valid and is cluster
independent, such as
SHOW CATALOGS or
SELECT version(). Do not close the
statement with a semicolon (;). For example:
Use of this panel is not required to successfully connect Tableau to clusters, but using it makes troubleshooting connection issues much easier. Without an initial SQL statement, if there is a problem connecting to the cluster, Tableau can fail to show an error dialog. This can leave the connection in a state where it appears to be successful but is unresponsive. With the initial SQL query in place, if there is a connection issue Tableau shows an error dialog that helps you diagnose the exact cause of the problem.
See the Learn More link in the Tableau Initial SQL panel for information on the limitations of the feature.
OAuth 2.0 authentication #
To use OAuth 2.0 to connect to Starburst, you must request and install a custom data connector file. Contact your account team for more information.
If you have a custom data connector file, install it as described in the download data connector section.
ODBC driver connection #
Open Tableau Desktop and begin the ODBC configuration. On the startup page, select Other Databases (ODBC), and configure as follows:
- Driver: Starburst ODBC Driver
- String Extras:
Driver=Starburst ODBC Driver;Catalog=<catalog>;Host=<host>;Port=<portDriver>;
String Extras field supports any of the ODBC connection properties from
the Starburst ODBC driver.
Select Sign In to establish the connection. If you are prompted for a password, this means the cluster has authentication enabled.
The Tableau ODBC documentation contains further information.
Legacy JDBC driver connection #
Tableau Prep Builder provides a generic connection method titled Other Databases (JDBC). Although Starburst strongly recommends using a Tableau data connector, this generic JDBC connection method is still available. Follow these steps:
Download the latest Trino JDBC driver.
Place the JDBC driver JAR file in the Tableau drivers directory:
- C:\Program Files\Tableau\Drivers
Do not store more than one Trino JDBC driver in this directory. Delete any older drivers when you update to a newer version. Connections to all connected data sources are made through the Trino JDBC driver.
Start Tableau Prep Builder and select Connect to a server using the Other Databases (JDBC) connector in Tableau.
Fill in the connection dialog as shown in the following table. For the URL field, use a JDBC connection string in this format:
The JDBC connection string must include the initial catalog to connect to. Once connected, you can select schemas and tables within that catalog, or select a different catalog.
If your cluster has TLS enabled, append the property
?SSL=trueto the connection string.
Field Value URL Full JDBC connection string for your cluster. Must include a catalog name, such as `mysql` in the following example. Dialect Must be 'SQL92' Username Your username Password Your password Properties File Specify or browse to the path of a JDBC properties file containing further specifications for this connection. See Customized JDBC Connections.
Is the information on this page helpful?