Skip to content

Commit bea8115

Browse files
committed
update docs
1 parent 0a0c093 commit bea8115

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
= Client Spooling Protocol
2+
:description: Enable and configure the Client Spooling Protocol in Trino for efficient handling of large result sets.
3+
:keywords: client spooling protocol, Trino, large result sets, memory management
4+
:trino-docs-spooling-url: https://trino.io/docs/476/client/client-protocol.html
5+
6+
The Client Spooling Protocol in Trino is designed to efficiently handle large result sets. When enabled, this protocol allows the Trino server to spool results to external storage systems, reducing memory consumption and improving performance for queries that return large datasets.
7+
8+
For more details, refer to the link:{trino-docs-spooling-url}[Trino documentation on Client Spooling Protocol {external-link-icon}^].
9+
10+
== Configuration
11+
12+
The client spooling protocol is disabled by default.
13+
To enable it, you need to set the `spec.clusterConfig.clientSpoolingProtocol` configuration property as shown below.
14+
15+
[source,yaml]
16+
----
17+
spec:
18+
clusterConfig:
19+
clientSpoolingProtocol:
20+
enabled: true # <1>
21+
location: "s3://spooling-bucket/trino/" # <2>
22+
filesystem:
23+
s3: # <3>
24+
connection:
25+
reference: "minio"
26+
----
27+
<1> Enables the client spooling protocol
28+
<2> Specifies the location where spooled data will be stored. This example uses an S3 bucket.
29+
<3> Configures the filesystem type for spooling. Only S3 is supported currently via the custom resource definition.
30+
31+
The operator automatically fills in additional settings required by Trino, such as the `protocol.spooling.shared-secret-key`.
32+
Users can change the contents of the `spooling-manager.properties` file by adding entries to the optional `spec.clusterConfig.clientSpoolingProtocol.config_overrides` map.
33+
34+
[IMPORTANT]
35+
====
36+
Even if enabled, Trino may decide to not use the client spooling protocol for certain queries. Clients cannot force Trino to use it.
37+
====
38+
39+
The clients need to have access to the same storage location configured for spooling.

docs/modules/trino/partials/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
** xref:trino:usage-guide/listenerclass.adoc[]
88
** xref:trino:usage-guide/configuration.adoc[]
99
** xref:trino:usage-guide/fault-tolerant-execution.adoc[]
10+
** xref:trino:usage-guide/client-spooling-protocol.adoc[]
1011
** xref:trino:usage-guide/s3.adoc[]
1112
** xref:trino:usage-guide/security.adoc[]
1213
** xref:trino:usage-guide/monitoring.adoc[]

0 commit comments

Comments
 (0)