diff --git a/docs/zh/14-reference/01-components/01-taosd.md b/docs/zh/14-reference/01-components/01-taosd.md index 602224de47..eb75c6ed7e 100644 --- a/docs/zh/14-reference/01-components/01-taosd.md +++ b/docs/zh/14-reference/01-components/01-taosd.md @@ -60,11 +60,11 @@ taosd 命令行参数如下 #### compressMsgSize - 说明：是否对 RPC 消息进行压缩 -- 类型：-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩 +- 类型：整数；-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩 - 默认值：-1 - 最小值：-1 - 最大值：100000000 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### shellActivityTimer @@ -74,7 +74,7 @@ taosd 命令行参数如下 - 默认值：3 - 最小值：1 - 最大值：120 -- 动态修改：支持动态修改，立即生效 +- 动态修改：支持通过 SQL 修改，立即生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### numOfRpcSessions @@ -83,7 +83,7 @@ taosd 命令行参数如下 - 默认值：30000 - 最小值：100 - 最大值：100000 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.1.0.0 版本开始引入 #### numOfRpcThreads @@ -92,7 +92,7 @@ taosd 命令行参数如下 - 默认值：CPU 核数的一半 - 最小值：1 - 最大值：50 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### numOfTaskQueueThreads @@ -101,7 +101,7 @@ taosd 命令行参数如下 - 默认值：CPU 核数的一半 - 最小值：4 - 最大值：16 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### rpcQueueMemoryAllowed @@ -111,7 +111,7 @@ taosd 命令行参数如下 - 默认值：服务器内存的 1/10 - 最小值：104857600 - 最大值：INT64_MAX -- 动态修改：支持动态修改，立即生效 +- 动态修改：支持通过 SQL 修改，立即生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### resolveFQDNRetryTime @@ -149,7 +149,7 @@ taosd 命令行参数如下 - 默认值：10000 - 最小值：0 - 最大值：86400000 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.3.4.0 版本开始引入 #### shareConnLimit @@ -158,7 +158,7 @@ taosd 命令行参数如下 - 默认值：10 - 最小值：1 - 最大值：512 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.3.4.0 版本开始引入 #### readTimeout @@ -168,34 +168,34 @@ taosd 命令行参数如下 - 默认值：900 - 最小值：64 - 最大值：604800 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.3.4.0 版本开始引入 ### 监控相关 #### monitor - 说明：是否收集监控数据并上报 -- 类型：0：关闭；1：打开 +- 类型：整数；0：关闭；1：打开 - 默认值：0 - 最小值：0 - 最大值：1 -- 动态修改：支持动态修改，立即生效 +- 动态修改：支持通过 SQL 修改，立即生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### monitorFqdn - 说明：taosKeeper 服务所在服务器的地址 - 类型：fqdn - 默认值：无 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.0.0.0 版本开始引入 -#### monitorFqdn +#### monitorPort - 说明：taosKeeper 服务所监听的端口号 - 类型：整数 - 默认值：6043 - 最小值：1 - 最大值：65056 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### monitorInterval @@ -205,7 +205,7 @@ taosd 命令行参数如下 - 默认值：30 - 最小值：1 - 最大值：200000 -- 动态修改：支持动态修改，立即生效 +- 动态修改：支持通过 SQL 修改，立即生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### monitorMaxLogs @@ -214,7 +214,7 @@ taosd 命令行参数如下 - 默认值：100 - 最小值：1 - 最大值：1000000 -- 动态修改：支持动态修改，立即生效 +- 动态修改：支持通过 SQL 修改，立即生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### monitorComp @@ -223,7 +223,7 @@ taosd 命令行参数如下 - 默认值：0 - 最小值：0 - 最大值：1 -- 动态修改：支持动态修改，重启后生效 +- 动态修改：支持通过 SQL 修改，重启后生效 - 支持版本：从 v3.0.0.0 版本开始引入 #### monitorLogProtocol @@ -232,7 +232,7 @@ taosd 命令行参数如下 - 默认值：0 - 最小值：0 - 最大值：1 -- 动态修改：支持动态修改，立即生效 +- 动态修改：支持通过 SQL 修改，立即生效 - 支持版本：从 v3.3.0.0 版本开始引入 #### monitorForceV2 @@ -241,28 +241,148 @@ taosd 命令行参数如下 - 默认值：1 - 最小值：0 - 最大值：1 -- 动态修改：支持动态修改，立即生效 +- 动态修改：支持通过 SQL 修改，立即生效 - 支持版本：从 v3.3.0.0 版本开始引入 +#### telemetryReporting +- 说明：是否上传 telemetry +- 类型：整数；0：关闭；1：打开 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 -|telemetryReporting | |支持动态修改 立即生效 |是否上传 telemetry，0：不上传，1：上传，默认值 1| -|telemetryServer | |不支持动态修改 |telemetry 服务器地址| -|telemetryPort | |不支持动态修改 |telemetry 服务器端口编号| -|telemetryInterval | |支持动态修改 立即生效 |telemetry 上传时间间隔，单位为秒，默认 86400| -|crashReporting | |支持动态修改 立即生效 |是否上传 crash 信息；0：不上传，1：上传；默认值 1| +#### telemetryServer +- 说明：telemetry 服务器地址 +- 类型：fqdn +- 默认值：telemetry.taosdata.com +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### telemetryPort +- 说明：telemetry 服务器端口号 +- 类型：整数 +- 默认值：80 +- 最小值：1 +- 最大值：65056 +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### telemetryInterval +- 说明：telemetry 上传时间间隔 +- 类型：整数 +- 单位：秒 +- 默认值：86400 +- 最小值：1 +- 最大值：200000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### crashReporting +- 说明：是否使用 V2 版本协议上报日志 +- 类型：整数；0：不上传；1：上传 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 ### 查询相关 -|参数名称|支持版本|动态修改|参数含义| -|------------------------|----------|-------------------------|-| -|countAlwaysReturnValue | |支持动态修改 立即生效 |count/hyperloglog 函数在输入数据为空或者 NULL 的情况下是否返回值；0：返回空行，1：返回；默认值 1；该参数设置为 1 时，如果查询中含有 INTERVAL 子句或者该查询使用了 TSMA 时，且相应的组或窗口内数据为空或者 NULL，对应的组或窗口将不返回查询结果；注意此参数客户端和服务端值应保持一致| -|tagFilterCache | |不支持动态修改 |是否缓存标签过滤结果| -|queryBufferSize | |支持动态修改 重启生效 |暂不生效| -|queryRspPolicy | |支持动态修改 立即生效 |查询响应策略| -|queryUseMemoryPool | |不支持动态修改 |查询是否使用内存池管理内存，默认值：1（打开）; 0: 关闭，1: 打开| -|minReservedMemorySize | |不支持动态修改 |最小预留的系统可用内存数量，除预留外的内存都可以被用于查询，单位：MB，默认预留大小为系统物理内存的 20%，取值范围 1024 - 1000000000| -|singleQueryMaxMemorySize| |不支持动态修改 |单个查询在单个节点(dnode)上可以使用的内存上限，超过该上限将返回错误，单位：MB，默认值：0（无上限），取值范围 0 - 1000000000| -|filterScalarMode | |不支持动态修改 |强制使用标量过滤模式，0：关闭；1：开启，默认值 0| -|queryPlannerTrace | |支持动态修改 立即生效 |内部参数，查询计划是否输出详细日志| + +#### countAlwaysReturnValue +- 说明：count/hyperloglog 函数在输入数据为空或者 NULL 的情况下是否返回值 +- 类型：整数；0：返回空行，1：如果查询中含有 INTERVAL 子句或者该查询使用了 TSMA，且相应的组或窗口内数据为空或者 NULL，对应的组或窗口将不返回查询结果 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### tagFilterCache +- 说明：是否缓存标签过滤结果 +- 类型：整数；0：不缓存，1：缓存 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### queryBufferSize +- 说明：查询可用的缓存大小 +- 类型：整数；-1 表示不限制 +- 单位：MB +- 默认值：-1 +- 最小值：-1 +- 最大值：500000000000 +- 动态修改：支持通过 SQL 修改，重启后效 +- 支持版本：预留参数，当前版本尚不支持 + +#### queryRspPolicy +- 说明：查询响应策略 +- 类型：整数；0：正常模式；1：快速响应模式，服务端收到查询消息后立即返回响应，而不是有查询结果后才响应 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### queryUseMemoryPool +- 说明：查询是否使用内存池管理内存 +- 类型：整数；0：关闭；1：打开 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：不支持 +- 支持版本：从 v3.3.5.0 版本开始引入 + +#### minReservedMemorySize +- 说明：最小预留的系统可用内存数量，除预留外的内存都可以被用于查询 +- 类型：整数 +- 单位：MB +- 默认值：系统物理内存的 20% +- 最小值：1024 +- 最大值：1000000000 +- 动态修改：不支持 +- 支持版本：从 v3.3.5.0 版本开始引入 + +#### singleQueryMaxMemorySize +- 说明：单个查询在单个节点(dnode)上可以使用的内存上限，超过该上限将返回错 +- 类型：整数；0：无上限 +- 单位：MB +- 默认值：0 +- 最小值：0 +- 最大值：1000000000 +- 动态修改：不支持 +- 支持版本：从 v3.3.5.0 版本开始引入 + +#### filterScalarMode +- 说明：强制使用标量过滤模式 +- 类型：整数；0：关闭；1：开启 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### queryNoFetchTimeoutSec +- 说明：查询中当应用长时间不 FETCH 数据时的超时时间，从最后一次响应起计时，超时自动清除任务 `内部参数` +- 类型：整数；0：关闭；1：开启 +- 默认值：18000 +- 最小值：60 +- 最大值：1000000000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### queryPlannerTrace +- 说明：查询计划是否输出详细日志 `内部参数` +- 类型：整数；0：关闭；1：开启 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + |queryNodeChunkSize | |支持动态修改 立即生效 |内部参数，查询计划的块大小| |queryUseNodeAllocator | |支持动态修改 立即生效 |内部参数，查询计划的分配方法| |queryMaxConcurrentTables| |不支持动态修改 |内部参数，查询计划的并发数目|