Skip to content

Commit

Permalink
Document spooling session properties
Browse files Browse the repository at this point in the history
  • Loading branch information
mosabua committed Jan 23, 2025
1 parent a54bd33 commit 4903810
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions docs/src/main/sphinx/admin/properties-client-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@ The following properties are related to the [](protocol-spooling).

- **Type:** [](prop-type-boolean)
- **Default value:** `true`
- **Session property:** `spooling_enabled`

Enable the support for the client [](protocol-spooling). The protocol is used if
client drivers and applications request usage, otherwise the direct protocol is
used automatically. The equivalent session property is `spooling_protocol_enabled`.
used automatically.

### `protocol.spooling.shared-secret-key`

Expand Down Expand Up @@ -79,36 +80,49 @@ Threshold for enabling compression with larger segments.
### `protocol.spooling.initial-segment-size`

- **Type:** [](prop-type-data-size)
- **Default value:** 8MB
- **Default value:** `8MB`
- **Minimum value:** `1KB`
- **Maximum value:** `128MB`
- **Session property:** `spooling_initial_segment_size`

Initial size of the spooled segments.

### `protocol.spooling.maximum-segment-size`
### `protocol.spooling.max-segment-size`

- **Type:** [](prop-type-data-size)
- **Default value:** 16MB
- **Default value:** `16MB`
- **Minimum value:** `1KB`
- **Maximum value:** `128MB`
- **Session property:** `spooling_max_segment_size`

Maximum size for each spooled segment.

### `protocol.spooling.inlining.enabled`

- **Type:** [](prop-type-boolean)
- **Default value:** `true`
- **Session property:** `spooling_inlining_enabled`

Allow spooled protocol to inline initial rows to decrease time to return the
first row.

### `protocol.spooling.inlining.max-rows`

- **Type:** [](prop-type-integer)
- **Default value:** 1000
- **Default value:** `1000`
- **Minimum value:** `1`
- **Maximum value:** `1000000`
- **Session property:** `spooling_inlining_max_size`

Maximum number of rows to inline per worker.

### `protocol.spooling.inlining.max-size`

- **Type:** [](prop-type-data-size)
- **Default value:** 128kB
- **Default value:** `128kB`
- **Minimum value:** `1KB`
- **Maximum value:** `1MB`
- **Session property:** `spooling_inlining_max_rows`

Maximum size of rows to inline per worker.

Expand Down

0 comments on commit 4903810

Please sign in to comment.