Client overview #
Starburst lets you query all the connected data sources with the most widely used and best supported query language — standard SQL. You can even query multiple data sources with the same query. Simple queries, and these more complex federated queries all access the data right in the source. There is no need for ETL processes.
As a data consumer, you can use any supported client tool to connect to your Starburst cluster and execute your queries. Many tools allow you much more powerful usage than simply running custom written queries. You can create complex reports, charts, dashboards, and many other useful results.
Basic connection information #
The details you need to connect to Starburst are independent of your preferred client tool. For a minimum connection without TLS, you need:
- URL of the Starburst cluster, including the port used.
- Credentials, typically username and password.
Ask your Starburst platform administrator for this information.
Let’s look at some examples:
A basic test installation on your local computer, using the default port and no TLS configuration:
- username can be a random string like your first name since no authorization is configured
- no password
The same basic test application running on a different server:
- random username string
- no password
/between the username and role value to be URL encoded with
%2F. A username in the form
email@example.com/accountadminmust be entered as
Default ports #
The following table shows the default ports for a SEP cluster:
|8080||Direct to coordinator, no security enabled|
|8443||Direct to TLS-enabled coordinator|
|80||Connect through load balancer or proxy server|
|443||TLS-enabled load balancer or proxy server|
TLS connection information #
If you enable TLS for your coordinator, you typically use a load balancer or
proxy. In this case, the default port is generally used, and the protocol
- random username string
TLS is a requirement for authorization against a provider’s data, such as your site’s LDAP directory. In this case, you must use real credentials:
- LDAP username
- LDAP password
If your client tool uses JDBC to connect, you must enable TLS support with the
SSL=true parameter in the JDBC configuration for your client, as described
in Enable JDBC TLS support.
Other authorization providers may require additional credentials. Support for other providers varies among client tools.
Determine cluster version #
The version of SEP running on the cluster determines compatibility of suitable clients. Specifically important is whether the cluster is using SEP 354-e or newer, or an older release prior to the rename of the open source project. Newer versions use the name Trino, while older releases up to 350-e use the Presto or PrestoSQL name.
You can determine the version of the cluster by asking your platform administrator, or with one of the following methods, depending on your access:
- Connect a client or browser to the
v1/infoREST endpoint. For example, connect to
- Connect a modern web browser to the cluster and log in to view the
SEP Web UI. For
example, connect to
http://starburst.example.com:8080/ui. The version number is shown on the right side of the top row.
- Connect the SEP CLI and run the following query:
select * from system.runtime.nodes;
General advice #
General advice for using clients is the following:
- For clusters running SEP version 350 or earlier, use version 350 of the client.
- For clusters running SEP version 350, you can use client version 350, 354 or newer to help with migration.
- For clusters running SEP versions 354 and later, use the same version of the client as the cluster or a newer client.
This applies for the CLI and JDBC driver. Some clients, such as ODBC driver, have separate versioning, and details are documented with the client. Other clients, including open source tools like DBeaver, use the Trino name for versions 354 or newer and PrestoSQL or Presto for older versions.
Starburst Enterprise version 360-e LTS recommended clients:
- CLI 360
- JDBC driver 360
- DBeaver with Trino connection
Starburst Enterprise version 345-e LTS recommended clients:
- CLI 350
- JDBC driver 350
- DBeaver with PrestoSQL connection
Starburst client tools and drivers #
Starburst offers a number of supported clients and tools:
- Query editor is included in Starburst Galaxy and the Starburst Enterprise web UI. It provides a convenient browser-based interface to author and execute your SQL queries.
- Command line interface (CLI) for shell scripts and manual execution using a terminal.
- Java Database Connectivity (JDBC) driver, typically for JVM-based applications and others with JDBC support.
- Open Database Connectivity (ODBC) driver, typically for Windows-based applications and others with OBDC support.
The JDBC and ODBC driver can be used for many other clients, and you can find instructions and specifics tips for the following tools:
Other client tools and drivers #
In addition, the Trino community provides the following clients:
The wider open source community maintains numerous other clients and tools that can be used.
The Trino Python client is fully supported on SEP, including certain Python-base open source data analysis clients, as described in Python clients.
Other resources #
The O’Reilly book, Trino, the Definitive Guide, was written here at Starburst, and contains some great information on getting started with using different types of clients with Starburst. It’s available for free!
Is the information on this page helpful?