Skip to content

docs: add max_connection_age config to grpc server options #2171

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: add max_connection_age config to grpc server options #2171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc9dfea
Initial plan
Copilot Oct 13, 2025
f2c2b92
docs: add max_connection_age config to grpc server options
Copilot Oct 13, 2025
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
1 change: 1 addition & 0 deletions docs/user-guide/deployments-administration/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ The following table describes the options in detail:
| grpc | | | gRPC server options |
| | bind_addr | String | The address to bind the gRPC server, "127.0.0.1:4001" by default |
| | runtime_size | Integer | The number of server worker threads, 8 by default |
| | max_connection_age | String | Maximum lifetime of a gRPC connection before the server gracefully closes it. If not set, connections are not closed based on age. Example: "1h" for 1 hour, "30m" for 30 minutes |
| | flight_compression | String | Compression mode for frontend side Arrow IPC service. Available options: `none`: disable all compression, `transport`: only enable gRPC transport compression (zstd), `arrow_ipc`: only enable Arrow IPC compression (lz4), `all`: enable all compression. Default value is `none`.|
| mysql | | | MySQL server options |
| | enable | Boolean | Whether to enable MySQL protocol, true by default |
Expand Down
1 change: 1 addition & 0 deletions ...gin-content-docs/current/user-guide/deployments-administration/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ enable = true
| grpc | | | gRPC 服务器选项 |
| | bind_addr | 字符串 | gRPC 服务绑定地址，默认为 "127.0.0.1:4001" |
| | runtime_size | 整数 | 服务器工作线程数量，默认为 8 |
| | max_connection_age | 字符串 | gRPC 连接在服务器优雅关闭之前的最大生命周期。如果未设置，则连接不会基于存活时间而关闭。示例："1h" 表示 1 小时，"30m" 表示 30 分钟 |
| | flight_compression | 字符串 | Frontend 的 Arrow IPC 服务的压缩模式。可用选项：`none`：禁用所有压缩，`transport`：仅启用 gRPC 传输压缩（zstd），`arrow_ipc`：仅启用 Arrow IPC 压缩（lz4），`all`：启用所有压缩。默认值为 `none`。|
| mysql | | | MySQL 服务器选项 |
| | enable | 布尔值 | 是否启用 MySQL 协议，默认为 true |
Expand Down
1 change: 1 addition & 0 deletions ...ontent-docs/version-0.17/user-guide/deployments-administration/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ enable = true
| grpc | | | gRPC 服务器选项 |
| | bind_addr | 字符串 | gRPC 服务绑定地址，默认为 "127.0.0.1:4001" |
| | runtime_size | 整数 | 服务器工作线程数量，默认为 8 |
| | max_connection_age | 字符串 | gRPC 连接在服务器优雅关闭之前的最大生命周期。如果未设置，则连接不会基于存活时间而关闭。示例："1h" 表示 1 小时，"30m" 表示 30 分钟 |
| | flight_compression | 字符串 | Frontend 的 Arrow IPC 服务的压缩模式。可用选项：`none`：禁用所有压缩，`transport`：仅启用 gRPC 传输压缩（zstd），`arrow_ipc`：仅启用 Arrow IPC 压缩（lz4），`all`：启用所有压缩。默认值为 `none`。|
| mysql | | | MySQL 服务器选项 |
| | enable | 布尔值 | 是否启用 MySQL 协议，默认为 true |
Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-0.17/user-guide/deployments-administration/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ The following table describes the options in detail:
| grpc | | | gRPC server options |
| | bind_addr | String | The address to bind the gRPC server, "127.0.0.1:4001" by default |
| | runtime_size | Integer | The number of server worker threads, 8 by default |
| | max_connection_age | String | Maximum lifetime of a gRPC connection before the server gracefully closes it. If not set, connections are not closed based on age. Example: "1h" for 1 hour, "30m" for 30 minutes |
| | flight_compression | String | Compression mode for frontend side Arrow IPC service. Available options: `none`: disable all compression, `transport`: only enable gRPC transport compression (zstd), `arrow_ipc`: only enable Arrow IPC compression (lz4), `all`: enable all compression. Default value is `none`.|
| mysql | | | MySQL server options |
| | enable | Boolean | Whether to enable MySQL protocol, true by default |
Expand Down