From c50f75b5d72b994bea1ad4104038ed2011fb3828 Mon Sep 17 00:00:00 2001 From: xiao-77 Date: Wed, 5 Feb 2025 10:07:48 +0800 Subject: [PATCH] docs:update taosc's connection config --- .../zh/14-reference/01-components/02-taosc.md | 109 +++++++++++++++--- 1 file changed, 95 insertions(+), 14 deletions(-) diff --git a/docs/zh/14-reference/01-components/02-taosc.md b/docs/zh/14-reference/01-components/02-taosc.md index 46b8854d27..314903666b 100755 --- a/docs/zh/14-reference/01-components/02-taosc.md +++ b/docs/zh/14-reference/01-components/02-taosc.md @@ -9,20 +9,101 @@ TDengine 客户端驱动提供了应用编程所需要的全部 API，并且在 ## 配置参数 ### 连接相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------------|----------|-------------------------|-------------| -|firstEp | |支持动态修改 立即生效 |启动时，主动连接的集群中首个 dnode 的 endpoint，缺省值：hostname:6030，若无法获取该服务器的 hostname，则赋值为 localhost| -|secondEp | |支持动态修改 立即生效 |启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint，没有缺省值| -|serverPort | |支持动态修改 立即生效 |taosd 监听的端口，默认值 6030| -|compressMsgSize | |支持动态修改 立即生效 |是否对 RPC 消息进行压缩；-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩；缺省值 -1| -|shellActivityTimer | |不支持动态修改 |客户端向 mnode 发送心跳的时长，单位为秒，取值范围 1-120，默认值 3| -|numOfRpcSessions | |支持动态修改 立即生效 |RPC 支持的最大连接数，取值范围 100-100000，缺省值 30000| -|numOfRpcThreads | |不支持动态修改 |RPC 收发数据线程数目，取值范围1-50,默认值为 CPU 核数的一半| -|numOfTaskQueueThreads | |不支持动态修改 |客户端处理 RPC消息的线程数, 范围4-16,默认值为 CPU 核数的一半| -|timeToGetAvailableConn| 3.3.4.*之后取消 |不支持动态修改 |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，缺省值 500000| -|useAdapter | |支持动态修改 立即生效 |内部参数，是否使用 taosadapter，影响 CSV 文件导入| -|shareConnLimit |3.3.4.0 新增|不支持动态修改 |内部参数，一个链接可以共享的查询数目，取值范围 1-256，默认值 10| -|readTimeout |3.3.4.0 新增|不支持动态修改 |内部参数，最小超时时间，取值范围 64-604800，单位为秒，默认值 900| + +#### firstEp +- 说明：启动时，主动连接的集群中首个 dnode 的 endpoint +- 默认值：hostname:6030，若无法获取该服务器的 hostname，则赋值为 localhost +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### secondEp +- 说明：启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint +- 默认值：无 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### serverPort +- 说明：taosd 监听的端口 +- 默认值：6030 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### compressMsgSize +- 说明：是否对 RPC 消息进行压缩 +- 类型：整数；-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩 +- 单位：bytes +- 默认值：-1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### shellActivityTimer +- 说明：客户端向 mnode 发送心跳的时长 +- 类型：整数 +- 单位：秒 +- 默认值：3 +- 最小值：1 +- 最大值：120 +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### numOfRpcSessions +- 说明：RPC 支持的最大连接数 +- 类型：整数 +- 默认值：30000 +- 最小值：100 +- 最大值：100000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### numOfRpcThreads +- 说明：RPC 收发数据线程数目 +- 类型：整数 +- 默认值：CPU 核数的一半 +- 最小值：1 +- 最大值：50 +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### numOfTaskQueueThreads +- 说明：客户端处理 RPC消息的线程数 +- 类型：整数 +- 默认值：CPU 核数的一半 +- 最小值：4 +- 最大值：16 +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### timeToGetAvailableConn +- 说明：获得可用连接的最长等待时间 +- 类型：整数 +- 单位：毫秒 +- 默认值：500000 +- 最小值：10 +- 最大值：50000000 +- 动态修改：不支持 +- 支持版本：3.3.4.*之后取消 + +#### useAdapter +- 说明：是否使用 taosadapter，影响 CSV 文件导入 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### shareConnLimit +- 说明：一个链接可以共享的查询数目 `内部参数` +- 最小值：1 +- 最大值：256 +- 默认值：10 +- 动态修改：不支持 +- 支持版本：从 v3.3.4.0 版本开始引入 + +#### readTimeout +- 说明：最小超时时间 `内部参数` +- 单位：秒 +- 最小值：64 +- 最大值：604800 +- 默认值：900 +- 动态修改：不支持 +- 支持版本：从 v3.3.4.0 版本开始引入 ### 查询相关 |参数名称|支持版本|动态修改|参数含义|