Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify requirements for CLI and JDBC driver #24288

Merged
merged 1 commit into from
Nov 28, 2024
Merged

Clarify requirements for CLI and JDBC driver #24288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions docs/src/main/sphinx/client/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,18 @@ queries. The CLI is a
[self-executing](http://skife.org/java/unix/2011/06/20/really_executable_jars.html)
JAR file, which means it acts like a normal UNIX executable.

The CLI uses the [](/client/client-protocol) over HTTP/HTTPS to communicate with
the coordinator on the cluster.

## Requirements

The CLI requires a Java virtual machine available on the path.
It can be used with Java version 8 and higher.
The Trino CLI has the following requirements:

The CLI uses the {doc}`Trino client REST API </develop/client-protocol>` over
HTTP/HTTPS to communicate with the coordinator on the cluster.
* Java version 8 or higher available on the path. Java 22 or higher is
recommended for improved decompression performance.
* Network access over HTTP/HTTPS to the coordinator of the Trino cluster.
* Network access to the configured object storage, if the
[](cli-spooling-protocol) is enabled.

The CLI version should be identical to the version of the Trino cluster, or
newer. Older versions typically work, but only a subset is regularly tested.
Expand Down Expand Up @@ -607,7 +612,7 @@ SELECT nationkey, name, region FROM tpch.sf1.nation LIMIT 3
(cli-spooling-protocol)=
## Spooling protocol

The Trino CLI automatically uses of the spooling protocol to improve throughput
The Trino CLI automatically uses the spooling protocol to improve throughput
for client interactions with higher data transfer demands, if the
[](protocol-spooling) is configured on the cluster.

Expand Down
13 changes: 8 additions & 5 deletions docs/src/main/sphinx/client/jdbc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,20 @@ users to access Trino using Java-based applications, and other non-Java
applications running in a JVM. Both desktop and server-side applications, such
as those used for reporting and database development, use the JDBC driver.

The JDBC driver uses the [](/client/client-protocol) over HTTP/HTTPS to
communicate with the coordinator on the cluster.

## Requirements

The Trino JDBC driver has the following requirements:

- Java version 8 or higher.
- Java version 8 or higher. Java 22 or higher is recommended for improved
decompression performance.
- All users that connect to Trino with the JDBC driver must be granted access to
query tables in the `system.jdbc` schema.
- Network access over HTTP/HTTPS to the coordinator of the Trino cluster.
- Network access to the configured object storage, if the
[](jdbc-spooling-protocol) is enabled.

The JDBC driver version should be identical to the version of the Trino cluster,
or newer. Older versions typically work, but only a subset is regularly tested.
Expand Down Expand Up @@ -45,10 +52,6 @@ classpath, you'll typically need to restart your application in order to
recognize the new driver. Then, depending on your application, you
may need to manually register and configure the driver.

The CLI uses the HTTP protocol and the
{doc}`Trino client REST API </develop/client-protocol>` to communicate
with Trino.

## Registering and configuring the driver

Drivers are commonly loaded automatically by applications once they are added to
Expand Down