Clients #

Starburst Galaxy includes the Query editor as a simple client to write and execute SQL statements in all clusters and their configured catalogs.

Many other clients are available and can be connected and used for SQL queries, charts and other visualizations, dashboards and other use cases.

Connection information #

You can view the connection details for a specific cluster by selecting Connection info in the list of clusters.

All connection information is displayed by default. Use the Select client menu to view connection information for a specific client:

Connection info display for a cluster

The dialog displays the user, host, and port information that you need for most client connections.

The user string concatenates the username, provided as email address, and the current role used by the logged in user.

The host is specific for each cluster and includes the account name and cluster name.

The port is 443, as used by default for TLS connections. The certificate used by Starburst Galaxy to secure the connection with TLS is a globally trusted certificate.

Select Trino JDBC as the client to view information for JDBC connections:

Connection info display for jdbc

Select Starburst ODBC as the client to view information for ODBC connections:

Connection info display for odbc

You may need your username when using ODBC connections.

Tableau and the ODBC driver allow you to download a connection file to simplify the connection process:

Connection info display for the connection file

See each client’s documentation, such as Tableau, to learn how to use these connection files.

Role specification #

When connecting via JDBC or ODBC, use the roles parameter to specify the default role for the connection. Specify the role with the following syntax: system=myrole. Use the roles parameter both when authenticating via username and password and via SSO.

Example JDBC connection string with the roles parameter:

jdbc:trino://starburst.example.com:43011/hive/sales?user=test&password=secret&SSL=true&roles=system:myrole

Example ODBC connection string with the roles parameter:

Driver={Starburst ODBC Driver};Host=starburst.example.com;Port=43011;AuthenticationType={LDAP Authentication};SSL=1;roles=system:myrole

SSO client access #

Starburst Galaxy supports SSO access with sing the Trino CLI or applications using the JDBC driver

Trino CLI

To configure SSO access for the Trino CLI:

  1. Use the --external-authentication option.
  2. In the Starburst Galaxy login, select your SSO provider.
  3. Log in using your SSO credentials.

JDBC

To configure SSO access for the JDBC driver:

  1. Add the external-authentication property and set it to true in your JDBC connection string or the user interface allowing you to set these properties. For example in DBeaver, use the driver properties tab of the connection configuration.
  2. In the Starburst Galaxy login, select the SSO provider.
  3. Log in using your SSO credentials.

ODBC

To configure SSO access for the ODBC driver:

  1. Add the AuthenticationType property and set it to OIDC Authentication
  2. Add the cacheAccessToken property and set it to 1:
    Driver={Starburst ODBC Driver};Host=starburst.example.com;Port=43011;AuthenticationType={OIDC Authentication};SSL=1;cacheAccessToken=1
    
  3. In the Starburst Galaxy login, select the SSO provider.
  4. Log in using your SSO credentials.

List of clients #

Use this information to connect to your cluster in Starburst Galaxy with the following supported and tested clients:

Other clients are not explicitly tested, but are expected to work as well.