diff --git a/docs/zh/14-reference/01-components/01-taosd.md b/docs/zh/14-reference/01-components/01-taosd.md index c45b3c8097..7090cda731 100644 --- a/docs/zh/14-reference/01-components/01-taosd.md +++ b/docs/zh/14-reference/01-components/01-taosd.md @@ -655,55 +655,367 @@ charset 的有效值是 UTF-8。 - 支持版本：从 v3.1.0.0 版本开始引入 ### 集群相关 -|参数名称|支持版本|动态修改|参数含义| -|--------------------------|----------|-------------------------|-| -|supportVnodes | |支持动态修改 立即生效 |dnode 支持的最大 vnode 数目，取值范围 0-4096，默认值 CPU 核数的 2 倍 + 5| -|numOfCommitThreads | |支持动态修改 重启生效 |落盘线程的最大数量，取值范围 1-1024，默认值为 4| -|numOfCompactThreads | |支持动态修改 重启生效 |落盘线程的最大数量，取值范围 1-16，默认值为 2| -|numOfMnodeReadThreads | |支持动态修改 重启生效 |mnode 的 Read 线程数目，取值范围 0-1024，默认值为 CPU 核数的四分之一（不超过 4）| -|numOfVnodeQueryThreads | |支持动态修改 重启生效 |vnode 的 Query 线程数目，取值范围 0-1024，默认值为 CPU 核数的两倍（不超过 16）| -|numOfVnodeFetchThreads | |支持动态修改 重启生效 |vnode 的 Fetch 线程数目，取值范围 0-1024，默认值为 CPU 核数的四分之一（不超过 4）| -|numOfVnodeRsmaThreads | |支持动态修改 重启生效 |vnode 的 Rsma 线程数目，取值范围 0-1024，默认值为 CPU 核数的四分之一（不超过 4）| -|numOfQnodeQueryThreads | |支持动态修改 重启生效 |qnode 的 Query 线程数目，取值范围 0-1024，默认值为 CPU 核数的两倍（不超过 16）| -|numOfSnodeSharedThreads | |支持动态修改 重启生效 |snode 的共享线程数目，取值范围 0-1024，默认值为 CPU 核数的四分之一（不小于 2，不超过 4）| -|numOfSnodeUniqueThreads | |支持动态修改 重启生效 |snode 的独占线程数目，取值范围 0-1024，默认值为 CPU 核数的四分之一（不小于 2，不超过 4）| -|ratioOfVnodeStreamThreads | |支持动态修改 重启生效 |流计算使用 vnode 线程的比例，取值范围 0.01-4，默认值 4| -|ttlUnit | |不支持动态修改 |ttl 参数的单位，取值范围 1-31572500，单位为秒，默认值 86400| -|ttlPushInterval | |支持动态修改 立即生效 |ttl 检测超时频率，取值范围 1-100000，单位为秒，默认值 10| -|ttlChangeOnWrite | |支持动态修改 立即生效 |ttl 到期时间是否伴随表的修改操作改变；0：不改变，1：改变；默认值为 0| -|ttlBatchDropNum | |支持动态修改 立即生效 |ttl 一批删除子表的数目，最小值为 0，默认值 10000| -|retentionSpeedLimitMB | |支持动态修改 立即生效 |数据在不同级别硬盘上迁移时的速度限制，取值范围 0-1024，单位 MB，默认值 0，表示不限制| -|maxTsmaNum | |支持动态修改 立即生效 |集群内可创建的TSMA个数；取值范围 0-3；默认值 3| -|tmqMaxTopicNum | |支持动态修改 立即生效 |订阅最多可建立的 topic 数量；取值范围 1-10000；默认值为 20| -|tmqRowSize | |支持动态修改 立即生效 |订阅数据块的最大记录条数，取值范围 1-1000000，默认值 4096| -|audit | |支持动态修改 立即生效 |审计功能开关；企业版参数| -|auditInterval | |支持动态修改 立即生效 |审计数据上报的时间间隔；企业版参数| -|auditCreateTable | |支持动态修改 立即生效 |是否针对创建子表开启申计功能；企业版参数| -|encryptAlgorithm | |不支持动态修改 |数据加密算法；企业版参数| -|encryptScope | |不支持动态修改 |加密范围；企业版参数| -|enableWhiteList | |支持动态修改 立即生效 |白名单功能开关；企业版参数| -|syncLogBufferMemoryAllowed| |支持动态修改 立即生效 |一个 dnode 允许的 sync 日志缓存消息占用的内存最大值，单位 bytes，取值范围 104857600-INT64_MAX，默认值 服务器内存的 1/10，3.1.3.2/3.3.2.13 版本开始生效 | -|syncElectInterval | |不支持动态修改 |内部参数，用于同步模块调试| -|syncHeartbeatInterval | |不支持动态修改 |内部参数，用于同步模块调试| -|syncHeartbeatTimeout | |不支持动态修改 |内部参数，用于同步模块调试| -|syncSnapReplMaxWaitN | |支持动态修改 立即生效 |内部参数，用于同步模块调试| -|arbHeartBeatIntervalSec | |支持动态修改 立即生效 |内部参数，用于同步模块调试| -|arbCheckSyncIntervalSec | |支持动态修改 立即生效 |内部参数，用于同步模块调试| -|arbSetAssignedTimeoutSec | |支持动态修改 立即生效 |内部参数，用于同步模块调试| -|mndSdbWriteDelta | |支持动态修改 立即生效 |内部参数，用于 mnode 模块调试| -|mndLogRetention | |支持动态修改 立即生效 |内部参数，用于 mnode 模块调试| -|skipGrant | |不支持动态修改 |内部参数，用于授权检查| -|trimVDbIntervalSec | |支持动态修改 立即生效 |内部参数，用于删除过期数据| -|ttlFlushThreshold | |支持动态修改 立即生效 |内部参数，ttl 定时器的频率| -|compactPullupInterval | |支持动态修改 立即生效 |内部参数，数据重整定时器的频率| -|walFsyncDataSizeLimit | |支持动态修改 立即生效 |内部参数，WAL 进行 FSYNC 的阈值| -|transPullupInterval | |支持动态修改 立即生效 |内部参数，mnode 执行事务的重试间隔| -|mqRebalanceInterval | |支持动态修改 立即生效 |内部参数，消费者再平衡的时间间隔| -|uptimeInterval | |支持动态修改 立即生效 |内部参数，用于记录系统启动时间| -|timeseriesThreshold | |支持动态修改 立即生效 |内部参数，用于统计用量| -|udf | |支持动态修改 重启生效 |是否启动 UDF 服务；0：不启动，1：启动；默认值为 0 | -|udfdResFuncs | |支持动态修改 重启生效 |内部参数，用于 UDF 结果集设置| -|udfdLdLibPath | |支持动态修改 重启生效 |内部参数，表示 UDF 装载的库路径| + +#### supportVnodes +- 说明：dnode 支持的最大 vnode 数目 +- 类型：整数 +- 默认值：CPU 核数的 2 倍 + 5 +- 最小值：0 +- 最大值：4096 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfCommitThreads +- 说明：落盘线程的最大数量 +- 类型：整数 +- 默认值：4 +- 最小值：1 +- 最大值：1024 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfCompactThreads +- 说明：合并线程的最大数量 +- 类型：整数 +- 默认值：2 +- 最小值：1 +- 最大值：16 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfMnodeReadThreads +- 说明：mnode 的 Read 线程数目 +- 类型：整数 +- 默认值：CPU 核数的四分之一（不超过 4） +- 最小值：0 +- 最大值：1024 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfVnodeQueryThreads +- 说明：vnode 的 Query 线程数目 +- 类型：整数 +- 默认值：CPU 核数的两倍（不超过 16） +- 最小值：0 +- 最大值：1024 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfVnodeFetchThreads +- 说明：vnode 的 Fetch 线程数目 +- 类型：整数 +- 默认值：CPU 核数的四分之一（不超过 4） +- 最小值：0 +- 最大值：1024 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfVnodeRsmaThreads +- 说明：vnode 的 Rsma 线程数目 +- 类型：整数 +- 默认值：CPU 核数的四分之一（不超过 4） +- 最小值：0 +- 最大值：1024 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfQnodeQueryThreads +- 说明：qnode 的 Query 线程数目 +- 类型：整数 +- 默认值：CPU 核数的两倍（不超过 16） +- 最小值：0 +- 最大值：1024 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfSnodeSharedThreads +- 说明：snode 的共享线程数目 +- 类型：整数 +- 默认值：CPU 核数的四分之一（不小于 2，不超过 4） +- 最小值：0 +- 最大值：1024 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfSnodeUniqueThreads +- 说明：snode 的独占线程数目 +- 类型：整数 +- 默认值：CPU 核数的四分之一（不小于 2，不超过 4） +- 最小值：0 +- 最大值：1024 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### ratioOfVnodeStreamThreads +- 说明：流计算使用 vnode 线程的比例 +- 类型：浮点数 +- 默认值：4 +- 最小值：0.01 +- 最大值：4 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### ttlUnit +- 说明：ttl 参数的单位 +- 类型：整数 +- 单位：秒 +- 默认值：86400 +- 最小值：1 +- 最大值：31572500 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### ttlPushInterval +- 说明：ttl 检测超时频率 +- 类型：整数 +- 单位：秒 +- 默认值：10 +- 最小值：1 +- 最大值：100000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### ttlChangeOnWrite +- 说明：ttl 到期时间是否伴随表的修改操作改变 +- 类型：整数；0：不改变，1：改变 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### ttlBatchDropNum +- 说明：ttl 一批删除子表的数目 +- 类型：整数 +- 默认值：10000 +- 最小值：0 +- 最大值：2147483647 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### retentionSpeedLimitMB +- 说明：数据在不同级别硬盘上迁移时的速度限制 +- 类型：整数 +- 单位：MB +- 默认值：0，表示不限制 +- 最小值：0 +- 最大值：1024 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### maxTsmaNum +- 说明：集群内可创建的TSMA个数 +- 类型：整数 +- 默认值：0 +- 最小值：0 +- 最大值：3 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### tmqMaxTopicNum +- 说明：订阅最多可建立的 topic 数量 +- 类型：整数 +- 默认值：20 +- 最小值：1 +- 最大值：10000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### tmqRowSize +- 说明：订阅数据块的最大记录条数 +- 类型：整数 +- 默认值：4096 +- 最小值：1 +- 最大值：1000000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### audit +- 说明：审计功能开关；`企业版参数` +- 类型：整数；0:关闭，1：开启 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### auditInterval +- 说明：审计数据上报的时间间隔；`企业版参数` +- 类型：整数 +- 默认值：5000 +- 最小值：500 +- 最大值：200000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### auditCreateTable +- 说明：是否针对创建子表开启申计功能；`企业版参数` +- 类型：整数；0:关闭，1：开启 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### encryptAlgorithm +- 说明：数据加密算法；`企业版参数` +- 类型：字符串 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### encryptScope +- 说明：加密范围；`企业版参数` +- 类型：字符串 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### enableWhiteList +- 说明：白名单功能开关；`企业版参数` +- 类型：整数；0:关闭，1：开启 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### syncLogBufferMemoryAllowed +- 说明：一个 dnode 允许的 sync 日志缓存消息占用的内存最大值 +- 类型：整数 +- 单位：bytes +- 默认值：服务器内存的 1/10 +- 最小值：104857600 +- 最大值：9223372036854775807 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：v3.1.3.2/v3.3.2.13 版本开始生效 + +#### syncElectInterval +- 说明：用于同步模块调试,`内部参数` +- 类型：整数 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### syncHeartbeatInterval +- 说明：用于同步模块调试,`内部参数` +- 类型：整数 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### syncHeartbeatTimeout +- 说明：用于同步模块调试,`内部参数` +- 类型：整数 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### syncSnapReplMaxWaitN +- 说明：用于同步模块调试,`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### arbHeartBeatIntervalSec +- 说明：用于同步模块调试,`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### arbCheckSyncIntervalSec +- 说明：用于同步模块调试,`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### arbSetAssignedTimeoutSec +- 说明：用于同步模块调试,`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### arbSetAssignedTimeoutSec +- 说明：用于 mnode 模块调试,`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### mndLogRetention +- 说明：用于 mnode 模块调试,`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### skipGrant +- 说明：用于授权检查,`内部参数` +- 类型：整数 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### trimVDbIntervalSec +- 说明：用于删除过期数据,`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### ttlFlushThreshold +- 说明：ttl 定时器的频率,`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### compactPullupInterval +- 说明：数据重整定时器的频率,`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### walFsyncDataSizeLimit +- 说明：WAL 进行 FSYNC 的阈值`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### transPullupInterval +- 说明：mnode 执行事务的重试间`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### mqRebalanceInterval +- 说明：消费者再平衡的时间间隔`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### uptimeInterval +- 说明：用于记录系统启动时间`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### timeseriesThreshold +- 说明：用于统计用量`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### udf +- 说明：是否启动 UDF 服务 +- 类型：整数0：不启动，1：启动 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### udfdResFuncs +- 说明：用于统计用量`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### udfdLdLibPath +- 说明：用于统计用量`内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 ### 流计算参数