From f794c4c7bc3d5d5fef53e655452974aa16c949e0 Mon Sep 17 00:00:00 2001 From: Bvsk Patnaik Date: Wed, 17 Jul 2024 13:07:18 -0700 Subject: [PATCH] [docs] Add ysql_output_buffer_size to yb-tserver config reference. @netlify preview/reference/configuration/yb-tserver/#ysql-output-buffer-size --- .../content/preview/reference/configuration/yb-tserver.md | 8 ++++++++ docs/content/stable/reference/configuration/yb-tserver.md | 8 ++++++++ docs/content/v2.20/reference/configuration/yb-tserver.md | 8 ++++++++ 3 files changed, 24 insertions(+) diff --git a/docs/content/preview/reference/configuration/yb-tserver.md b/docs/content/preview/reference/configuration/yb-tserver.md index fff0e4835bca..e1b2381d05cd 100644 --- a/docs/content/preview/reference/configuration/yb-tserver.md +++ b/docs/content/preview/reference/configuration/yb-tserver.md @@ -855,6 +855,14 @@ Default: `-1` (disables logging statement durations) Specifies the lowest YSQL message level to log. +##### --ysql_output_buffer_size + +Size of YSQL layer output buffer, in bytes. YSQL buffers query responses in this output buffer until either a buffer flush is requested by the client or the buffer overflows. + +As long as no data has been flushed from the buffer, the database can retry queries on retryable errors. For example, you can increase the size of the buffer so that YSQL can retry [read restart errors](../../../architecture/transactions/read-restart-error). + +Default: `262144` (256kB, type: int32) + ### YCQL The following flags support the use of the [YCQL API](../../../api/ycql/): diff --git a/docs/content/stable/reference/configuration/yb-tserver.md b/docs/content/stable/reference/configuration/yb-tserver.md index f4c285516396..15ad7966c670 100644 --- a/docs/content/stable/reference/configuration/yb-tserver.md +++ b/docs/content/stable/reference/configuration/yb-tserver.md @@ -855,6 +855,14 @@ Default: `-1` (disables logging statement durations) Specifies the lowest YSQL message level to log. +##### --ysql_output_buffer_size + +Size of YSQL layer output buffer, in bytes. YSQL buffers query responses in this output buffer until either a buffer flush is requested by the client or the buffer overflows. + +As long as no data has been flushed from the buffer, the database can retry queries on retryable errors. For example, you can increase the size of the buffer so that YSQL can retry [read restart errors](../../../architecture/transactions/read-restart-error). + +Default: `262144` (256kB, type: int32) + ### YCQL The following flags support the use of the [YCQL API](../../../api/ycql/): diff --git a/docs/content/v2.20/reference/configuration/yb-tserver.md b/docs/content/v2.20/reference/configuration/yb-tserver.md index ffd6cdf57e58..75073fcda92e 100644 --- a/docs/content/v2.20/reference/configuration/yb-tserver.md +++ b/docs/content/v2.20/reference/configuration/yb-tserver.md @@ -732,6 +732,14 @@ Default: `-1` (disables logging statement durations) Specifies the lowest YSQL message level to log. +##### --ysql_output_buffer_size + +Size of YSQL layer output buffer, in bytes. YSQL buffers query responses in this output buffer until either a buffer flush is requested by the client or the buffer overflows. + +As long as no data has been flushed from the buffer, the database can retry queries on retryable errors. For example, you can increase the size of the buffer so that YSQL can retry [read restart errors](../../../architecture/transactions/read-restart-error). + +Default: `262144` (256kB, type: int32) + ### YCQL The following flags support the use of the [YCQL API](../../../api/ycql/):