diff --git a/docs/zh/14-reference/01-components/01-taosd.md b/docs/zh/14-reference/01-components/01-taosd.md index bb0c8b7fb7..8dc0257cfe 100644 --- a/docs/zh/14-reference/01-components/01-taosd.md +++ b/docs/zh/14-reference/01-components/01-taosd.md @@ -13,7 +13,9 @@ taosd 命令行参数如下 - -c ``：指定配置文件所在目录 - -s：打印 SDB 信息 - -C: 打印配置信息 -- -e: 指定环境变量，其格式形如 `-e 'TAOS_FQDN=td1'` +- -e: 指定环境变量的字符串，例如：`-e 'TAOS_FQDN=td1'` +- -E: 指定环境变量的文件路径，默认是 `./.env`，.env 文件中的内容可以是 `TAOS_FQDN=td1` +- -o: 指定日志输入方式，可选 `stdout`, `stderr`, `/dev/null`, ``,` /`, `` - -k: 获取机器码 - -dm: 启用内存调度 - -V: 打印版本信息 @@ -21,67 +23,440 @@ taosd 命令行参数如下 ## 配置参数 :::note -配置文件参数修改后，需要重启*taosd*服务，或客户端应用才能生效。 - +配置文件参数修改后，需要重启*taosd*服务，或客户端应用才能生效 ::: ### 连接相关 -|参数名称|支持版本|动态修改|参数含义| -|-----------------------|-------------------------|-------------------------|------------| -|firstEp | |不支持动态修改 |taosd 启动时，主动连接的集群中首个 dnode 的 end point，默认值 localhost:6030| -|secondEp | |不支持动态修改 |taosd 启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint，无默认值| -|fqdn | |不支持动态修改 |taosd 监听的服务地址，默认为所在服务器上配置的第一个 hostname| -|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 核数的一半| -|rpcQueueMemoryAllowed | |支持动态修改 立即生效 |dnode允许的已经收到的RPC消息占用的内存最大值，单位 bytes，取值范围 104857600-INT64_MAX，默认值为服务器内存的 1/10 | -|resolveFQDNRetryTime | 3.x 之后取消 |不支持动态修改 |FQDN 解析失败时的重试次数| -|timeToGetAvailableConn | 3.3.4.x之后取消 |支持动态修改 重启生效 |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，默认值 500000| -|maxShellConns | 3.x 后取消 |支持动态修改 重启生效 |允许创建的最大链接数| -|maxRetryWaitTime | |支持动态修改 重启生效 |重连最大超时时间, 从重试时候开始计算, 取值范围0-86400000, 单位为毫秒, 默认值10000| -|shareConnLimit |3.3.4.0 新增 |支持动态修改 重启生效 |一个链接可以共享的请求的数目，取值范围 1-512，默认值 10| -|readTimeout |3.3.4.0 新增 |支持动态修改 重启生效 |单个请求最小超时时间，取值范围 64-604800，单位为秒，默认值 900| + +#### firstEp +- 说明：taosd 启动时，主动连接的集群中首个 dnode 的 end point +- 类型：endpoint +- 默认值：localhost:6030 +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### secondEp +- 说明：taosd 启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint +- 类型：endpoint +- 默认值：无 +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### fqdn +- 说明：taosd 监听的服务地址 +- 类型：fqdn +- 默认值：所在服务器上配置的第一个 hostname +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### serverPort +- 说明：taosd 监听的端口 +- 类型：整数 +- 默认值：6030 +- 最小值：1 +- 最大值：65056 +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### compressMsgSize +- 说明：是否对 RPC 消息进行压缩 +- 类型：整数；-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩 +- 默认值：-1 +- 最小值：-1 +- 最大值：100000000 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### shellActivityTimer +- 说明：客户端向 mnode 发送心跳的时长 +- 类型：整数 +- 单位：秒 +- 默认值：3 +- 最小值：1 +- 最大值：120 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### numOfRpcSessions +- 说明：RPC 支持的最大连接数 +- 类型：整数 +- 默认值：30000 +- 最小值：100 +- 最大值：100000 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfRpcThreads +- 说明：RPC 收发数据的线程数目 +- 类型：整数 +- 默认值：CPU 核数的一半 +- 最小值：1 +- 最大值：50 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### numOfTaskQueueThreads +- 说明：RPC 处理消息的线程数目 +- 类型：整数 +- 默认值：CPU 核数的一半 +- 最小值：4 +- 最大值：16 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### rpcQueueMemoryAllowed +- 说明：dnode 已经收到并等待处理的 RPC 消息占用内存的最大值 +- 类型：整数 +- 单位：byte +- 默认值：服务器内存的 1/10 +- 最小值：104857600 +- 最大值：INT64_MAX +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### resolveFQDNRetryTime +- 说明：FQDN 解析失败时的重试次数 +- 类型：整数 +- 默认值：100 +- 最小值：1 +- 最大值：10240 +- 动态修改：不支持 +- 支持版本：v3.3.4.0 版本之后取消 + +#### timeToGetAvailableConn +- 说明：获得可用连接的最长等待时间 +- 类型：整数 +- 单位：毫秒 +- 默认值：500000 +- 最小值：20 +- 最大值：1000000 +- 动态修改：不支持 +- 支持版本：v3.3.4.0 版本之后取消 + +#### maxShellConns +- 说明：允许创建的最大链接数 +- 类型：整数 +- 默认值：50000 +- 最小值：10 +- 最大值：50000000 +- 动态修改：不支持 +- 支持版本：v3.3.4.0 版本之后取消 + +#### maxRetryWaitTime +- 说明：重连最大超时时间, 从重试时候开始计算 +- 类型：整数 +- 单位：毫秒 +- 默认值：10000 +- 最小值：0 +- 最大值：86400000 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.3.4.0 版本开始引入 + +#### shareConnLimit +- 说明：一个链接可以共享的请求的数目 +- 类型：整数 +- 默认值：10 +- 最小值：1 +- 最大值：512 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.3.4.0 版本开始引入 + +#### readTimeout +- 说明：单个请求最小超时时间 +- 类型：整数 +- 单位：秒 +- 默认值：900 +- 最小值：64 +- 最大值：604800 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.3.4.0 版本开始引入 ### 监控相关 -|参数名称|支持版本|动态修改|参数含义| -|-----------------------|----------|-------------------------|-| -|monitor | |支持动态修改 立即生效 |是否收集监控数据并上报，0：关闭；1:打开；默认值 0| -|monitorFqdn | |支持动态修改 重启生效 |taosKeeper 服务所在服务器的 FQDN，默认值 无| -|monitorPort | |支持动态修改 重启生效 |taosKeeper 服务所监听的端口号，默认值 6043| -|monitorInterval | |支持动态修改 立即生效 |监控数据库记录系统参数（CPU/内存）的时间间隔，单位是秒，取值范围 1-200000 ，默认值 30| -|monitorMaxLogs | |支持动态修改 立即生效 |缓存的待上报日志条数| -|monitorComp | |支持动态修改 重启生效 |是否采用压缩方式上报监控日志时| -|monitorLogProtocol | |支持动态修改 立即生效 |是否打印监控日志| -|monitorForceV2 | |支持动态修改 立即生效 |是否使用 V2 版本协议上报| -|telemetryReporting | |支持动态修改 立即生效 |是否上传 telemetry，0：不上传，1：上传，默认值 1| -|telemetryServer | |不支持动态修改 |telemetry 服务器地址| -|telemetryPort | |不支持动态修改 |telemetry 服务器端口编号| -|telemetryInterval | |支持动态修改 立即生效 |telemetry 上传时间间隔，单位为秒，默认 86400| -|crashReporting | |支持动态修改 立即生效 |是否上传 crash 信息；0：不上传，1：上传；默认值 1| + +#### monitor +- 说明：是否收集监控数据并上报 +- 类型：整数；0：关闭；1：打开 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### monitorFqdn +- 说明：taosKeeper 服务所在服务器的地址 +- 类型：fqdn +- 默认值：无 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### monitorPort +- 说明：taosKeeper 服务所监听的端口号 +- 类型：整数 +- 默认值：6043 +- 最小值：1 +- 最大值：65056 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### monitorInterval +- 说明：监控数据库记录系统参数（CPU/内存）的时间间隔 +- 类型：整数 +- 单位：秒 +- 默认值：30 +- 最小值：1 +- 最大值：200000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### monitorMaxLogs +- 说明：缓存的待上报日志条数 +- 类型：整数 +- 默认值：100 +- 最小值：1 +- 最大值：1000000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### monitorComp +- 说明：是否采用压缩方式上报监控日志 +- 类型：整数 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，重启后生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### monitorLogProtocol +- 说明：是否打印监控日志 +- 类型：整数 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.0.0 版本开始引入 + +#### monitorForceV2 +- 说明：是否使用 V2 版本协议上报日志 +- 类型：整数 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.0.0 版本开始引入 + +#### telemetryReporting +- 说明：是否上传 telemetry +- 类型：整数；0：关闭；1：打开 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### 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| -|queryRsmaTolerance | |不支持动态修改 |内部参数，用于判定查询哪一级 rsma 数据时的容忍时间，单位为毫秒| -|pqSortMemThreshold | |不支持动态修改 |内部参数，排序使用的内存阈值| + +#### 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 +- 说明：查询计划的块大小 `内部参数` +- 类型：整数 +- 单位：byte +- 默认值：32 * 1024 +- 最小值：1024 +- 最大值：128 * 1024 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### queryUseNodeAllocator +- 说明：查询计划的分配方法 `内部参数` +- 类型：整数；0：关闭；1：开启 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### queryMaxConcurrentTables +- 说明：查询计划的分配方法 `内部参数` +- 类型：整数 +- 默认值：200 +- 最小值：INT64_M +- 最大值：INT64_MAX +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### queryRsmaTolerance +- 说明：查询计划的分配方法 `内部参数` +- 类型：整数 +- 默认值：1000 +- 最小值：0 +- 最大值：900000 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### enableQueryHb +- 说明：是否发送查询心跳消息 `内部参数` +- 类型：整数；0：关闭；1：开启 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### pqSortMemThreshold +- 说明：排序使用的内存阈值 `内部参数` +- 类型：整数 +- 单位：MB +- 默认值：16 +- 最小值：1 +- 最大值：10240 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 ### 区域相关 -|参数名称|支持版本|动态修改|参数含义| -|-----------------|----------|-------------------------|-| -|timezone | |不支持动态修改 |时区；缺省从系统中动态获取当前的时区设置| -|locale | |不支持动态修改 |系统区位信息及编码格式，缺省从系统中获取| -|charset | |不支持动态修改 |字符集编码，缺省从系统中获取| +#### timezone +- 说明：时区 +- 默认值：从系统中动态获取当前的时区设置 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### locale +- 说明：系统区位信息及编码格式 +- 默认值：从系统中获取 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### charset +- 说明：字符集编码 +- 默认值：从系统中获取 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 :::info 1. 为应对多时区的数据写入和查询问题，TDengine 采用 Unix 时间戳(Unix Timestamp)来记录和存储时间戳。Unix 时间戳的特点决定了任一时刻不论在任何时区，产生的时间戳均一致。需要注意的是，Unix 时间戳是在客户端完成转换和记录。为了确保客户端其他形式的时间转换为正确的 Unix 时间戳，需要设置正确的时区。 @@ -159,151 +534,938 @@ charset 的有效值是 UTF-8。 ::: ### 存储相关 -|参数名称|支持版本|动态修改|参数含义| -|--------------------|----------|-------------------------|-| -|dataDir | |不支持动态修改 |数据文件目录，所有的数据文件都将写入该目录，默认值 /var/lib/taos| -|diskIDCheckEnabled | |不支持动态修改 |在 3.3.4.3 后，在重启 dnode 时增加了检查 dataDir 所在磁盘 id 是否发生改变，0:进行检查，1:不进行检查；默认值：1| -|tempDir | |不支持动态修改 |指定所有系统运行过程中的临时文件生成的目录，默认值 /tmp| -|minimalDataDirGB | |不支持动态修改 |dataDir 指定的时序数据存储目录所需要保留的最小空间，单位 GB，默认值 2| -|minimalTmpDirGB | |不支持动态修改 |tempDir 所指定的临时文件目录所需要保留的最小空间，单位 GB，默认值 1| -|minDiskFreeSize |3.1.1.0 后|支持动态修改 立即生效 |当某块磁盘上的可用空间小于等于这个阈值时，该磁盘将不再被选择用于生成新的数据文件，单位为字节，取值范围 52428800-1073741824，默认值为 52428800；企业版参数| -|s3MigrateIntervalSec|3.3.4.3 后|支持动态修改 立即生效 |本地数据文件自动上传 S3 的触发周期，单位为秒。最小值：600；最大值：100000。默认值 3600；企业版参数| -|s3MigrateEnabled |3.3.4.3 后|支持动态修改 立即生效 |是否自动进行 S3 迁移，默认值为 0，表示关闭自动 S3 迁移，可配置为 1；企业版参数| -|s3Accesskey |3.3.4.3 后|支持动态修改 重启生效 |冒号分隔的用户 SecretId:SecretKey，例如 AKIDsQmwsfKxTo2A6nGVXZN0UlofKn6JRRSJ:lIdoy99ygEacU7iHfogaN2Xq0yumSm1E；企业版参数| -|s3Endpoint |3.3.4.3 后|支持动态修改 重启生效 |用户所在地域的 COS 服务域名，支持 http 和 https，bucket 的区域需要与 endpoint 保持一致，否则无法访问；企业版参数| -|s3BucketName |3.3.4.3 后|支持动态修改 重启生效 |存储桶名称，减号后面是用户注册 COS 服务的 AppId，其中 AppId 是 COS 特有，AWS 和阿里云都没有，配置时需要作为 bucket name 的一部分，使用减号分隔；参数值均为字符串类型，但不需要引号；例如 test0711-1309024725；企业版参数| -|s3PageCacheSize |3.3.4.3 后|支持动态修改 重启生效 |S3 page cache 缓存页数目，取值范围 4-1048576，单位为页，默认值 4096；企业版参数| -|s3UploadDelaySec |3.3.4.3 后|支持动态修改 立即生效 |data 文件持续多长时间不再变动后上传至 S3，取值范围 1-2592000 (30天），单位为秒，默认值 60；企业版参数| -|cacheLazyLoadThreshold| |支持动态修改 立即生效 |内部参数，缓存的装载策略| + +#### dataDir +- 说明：数据文件目录，所有的数据文件都将写入该目录 +- 类型：字符串 +- 默认值：/var/lib/taos +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### diskIDCheckEnabled +- 说明：在重启 dnode 时增加了检查 dataDir 所在磁盘 id 是否发生改变 +- 类型：整数；0:进行检查，1:不进行检查 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 支持版本：从 v3.3.5.0 版本开始引入 + +#### tempDir +- 说明：指定所有系统运行过程中的临时文件生成的目录 +- 类型：字符串 +- 默认值：/tmp +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### minimalDataDirGB +- 说明：dataDir 指定的时序数据存储目录所需要保留的最小空间 +- 类型：浮点数 +- 单位：GB +- 默认值：2 +- 最小值：0.001f +- 最大值：10000000 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### minimalTmpDirGB +- 说明：tempDir 所指定的临时文件目录所需要保留的最小空间 +- 类型：浮点数 +- 单位：GB +- 默认值：1 +- 最小值：0.001f +- 最大值：10000000 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### minDiskFreeSize +- 说明：当某块磁盘上的可用空间小于等于这个阈值时，该磁盘将不再被选择用于生成新的数据文件 `企业版参数` +- 类型：整数 +- 单位：byte +- 默认值：52428800 +- 最小值：52428800 +- 最大值：1073741824 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### s3MigrateIntervalSec +- 说明：本地数据文件自动上传 S3 的触发周期 `企业版参数` +- 类型：整数 +- 单位：秒 +- 默认值：3600 +- 最小值：600 +- 最大值：100000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### s3MigrateEnabled +- 说明：是否自动进行 S3 迁移 `企业版参数` +- 类型：整数；0:关闭，1:开启 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### s3Accesskey +- 说明：冒号分隔的用户 SecretId:SecretKey `企业版参数` +- 示例：AKIDsQmwsfKxTo2A6nGVXZN0UlofKn6JRRSJ:lIdoy99ygEacU7iHfogaN2Xq0yumSm1E +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### s3Endpoint +- 说明：用户所在地域的 COS 服务域名，支持 http 和 https，bucket 的区域需要与 endpoint 保持一致，否则无法访问 `企业版参数` +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### s3BucketName +- 说明：存储桶名称，减号后面是用户注册 COS 服务的 AppId，其中 AppId 是 COS 特有，AWS 和阿里云都没有，配置时需要作为 bucket name 的一部分，使用减号分隔；参数值均为字符串类型，但不需要引号 `企业版参数` +- 示例：test0711-1309024725 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### s3PageCacheSize +- 说明：S3 page cache 缓存页数目 `企业版参数` +- 类型：整数 +- 单位：页 +- 默认值：4096 +- 最小值：4 +- 最大值：1048576 +- 示例：test0711-1309024725 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### s3UploadDelaySec +- 说明：data 文件持续多长时间不再变动后上传至 S3 `企业版参数` +- 类型：整数 +- 单位：秒 +- 默认值：60 +- 最小值：1 +- 最大值：2592000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### cacheLazyLoadThreshold +- 说明：缓存的装载策略 `内部参数` +- 类型：整数 +- 默认值：500 +- 最小值：0 +- 最大值：100000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 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，默认值 0.5| -|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 线程的比例 +- 类型：浮点数 +- 默认值：0.5 +- 最小值：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 版本开始引入 ### 流计算参数 -|参数名称|支持版本|动态修改|参数含义| -|-----------------------|-------------------------|----------|-| -|disableStream | |支持动态修改 重启生效 |流计算的启动开关| -|streamBufferSize | |支持动态修改 重启生效 |控制内存中窗口状态缓存的大小，默认值为 128MB| -|streamAggCnt | |不支持动态修改 |内部参数，并发进行聚合计算的数目| -|checkpointInterval | |支持动态修改 重启生效 |内部参数，checkponit 同步间隔| -|concurrentCheckpoint | |支持动态修改 立即生效 |内部参数，是否并发检查 checkpoint| -|maxStreamBackendCache | |支持动态修改 立即生效 |内部参数，流计算使用的最大缓存| -|streamSinkDataRate | |支持动态修改 重启生效 |内部参数，用于控制流计算结果的写入速度| + +#### disableStream +- 说明：流计算的启动开关 +- 类型：整数；0：启动，1：关闭 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### streamBufferSize +- 说明：控制内存中窗口状态缓存的大小 +- 类型：整数 +- 单位：bytes +- 默认值：128 * 1024 * 1024 +- 最小值：0 +- 最大值：9223372036854775807 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### streamAggCnt +- 说明：并发进行聚合计算的数目 `内部参数` +- 类型：整数 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### checkpointInterval +- 说明：checkponit 同步间隔 `内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### concurrentCheckpoint +- 说明：是否并发检查 checkpoint `内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### maxStreamBackendCache +- 说明：流计算使用的最大缓存 `内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### streamSinkDataRate +- 说明：用于控制流计算结果的写入速度 `内部参数` +- 类型：整数 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 ### 日志相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------|-------------------------|----------|-| -|logDir | |不支持动态修改 |日志文件目录，运行日志将写入该目录，默认值 /var/log/taos| -|minimalLogDirGB | ｜不支持动态修改 |日志文件夹所在磁盘可用空间大小小于该值时，停止写日志，单位 GB，默认值 1| -|numOfLogLines | ｜支持动态修改 立即生效 |单个日志文件允许的最大行数，默认值 10,000,000| -|asyncLog | |支持动态修改 立即生效 |日志写入模式，0：同步，1：异步，默认值 1| -|logKeepDays | ｜支持动态修改 立即生效 |日志文件的最长保存时间，单位：天，默认值 0，小于等于0意味着只有两个日志文件相互切换保存日志，超过两个文件保存数量的日志会被删除；当设置为大于 0 的值时，当日志文件大小达到设置的上限时会被重命名为 taosdlog.yyy，其中 yyy 为日志文件最后修改的时间戳，并滚动产生新的日志文件| -|slowLogThreshold|3.3.3.0 后|支持动态修改 立即生效 |慢查询门限值，大于等于门限值认为是慢查询，单位秒，默认值 3 | -|slowLogMaxLen |3.3.3.0 后|支持动态修改 立即生效 |慢查询日志最大长度，取值范围 1-16384，默认值 4096| -|slowLogScope |3.3.3.0 后|支持动态修改 立即生效 |慢查询记录类型，取值范围 ALL/QUERY/INSERT/OTHERS/NONE，默认值 QUERY| -|slowLogExceptDb |3.3.3.0 后|支持动态修改 立即生效 |指定的数据库不上报慢查询，仅支持配置换一个数据库| -|debugFlag | |支持动态修改 立即生效 |运行日志开关，131（输出错误和警告日志），135（输出错误、警告和调试日志），143（输出错误、警告、调试和跟踪日志）；默认值 131 或 135 （取决于不同模块），该参数的设置会影响所有模块的开关，后设置的参数起效| -|tmrDebugFlag | |支持动态修改 立即生效 |定时器模块的日志开关，取值范围同上| -|uDebugFlag | |支持动态修改 立即生效 |共用功能模块的日志开关，取值范围同上| -|rpcDebugFlag | |支持动态修改 立即生效 |rpc 模块的日志开关，取值范围同上| -|qDebugFlag | |支持动态修改 立即生效 |query 模块的日志开关，取值范围同上| -|dDebugFlag | |支持动态修改 立即生效 |dnode 模块的日志开关，取值范围同上| -|vDebugFlag | |支持动态修改 立即生效 |vnode 模块的日志开关，取值范围同上| -|mDebugFlag | |支持动态修改 立即生效 |mnode 模块的日志开关，取值范围同上| -|azDebugFlag |3.3.4.3 后|支持动态修改 立即生效 |S3 模块的日志开关，取值范围同上| -|sDebugFlag | |支持动态修改 立即生效 |sync 模块的日志开关，取值范围同上| -|tsdbDebugFlag | |支持动态修改 立即生效 |tsdb 模块的日志开关，取值范围同上| -|tqDebugFlag | |支持动态修改 立即生效 |tq 模块的日志开关，取值范围同上| -|fsDebugFlag | |支持动态修改 立即生效 |fs 模块的日志开关，取值范围同上| -|udfDebugFlag | |支持动态修改 立即生效 |udf 模块的日志开关，取值范围同上| -|smaDebugFlag | |支持动态修改 立即生效 |sma 模块的日志开关，取值范围同上| -|idxDebugFlag | |支持动态修改 立即生效 |index 模块的日志开关，取值范围同上| -|tdbDebugFlag | |支持动态修改 立即生效 |tdb 模块的日志开关，取值范围同上| -|metaDebugFlag | |支持动态修改 立即生效 |meta 模块的日志开关，取值范围同上| -|stDebugFlag | |支持动态修改 立即生效 |stream 模块的日志开关，取值范围同上| -|sndDebugFlag | |支持动态修改 立即生效 |snode 模块的日志开关，取值范围同上| + +#### logDir +- 说明：日志文件目录，运行日志将写入该目录 +- 类型：字符串 +- 默认值：/var/log/taos +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### minimalLogDirGB +- 说明：日志文件夹所在磁盘可用空间大小小于该值时，停止写日志 +- 类型：浮点数 +- 单位：GB +- 默认值：1 +- 最小值：0.001f +- 最大值：10000000 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfLogLines +- 说明：单个日志文件允许的最大行数 +- 类型：整数 +- 默认值：10,000,000 +- 最小值：1000 +- 最大值：2000000000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### asyncLog +- 说明：日志写入模式 +- 类型：整数；0：同步，1：异步 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### logKeepDays +- 说明：日志文件的最长保存时间，小于等于0意味着只有两个日志文件相互切换保存日志，超过两个文件保存数量的日志会被删除；当设置为大于 0 的值时，当日志文件大小达到设置的上限时会被重命名为 taosdlog.yyy，其中 yyy 为日志文件最后修改的时间戳，并滚动产生新的日志文件 +- 类型：整数；0 +- 单位：天 +- 默认值：0 +- 最小值：-365000 +- 最大值：365000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### slowLogThreshold +- 说明：慢查询门限值，大于等于门限值认为是慢查询 +- 类型：整数 +- 单位：秒 +- 默认值：3 +- 最小值：1 +- 最大值：2147483647 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.0.0 版本开始引入 + +#### slowLogMaxLen +- 说明：慢查询日志最大长度 +- 类型：整数 +- 默认值：4096 +- 最小值：1 +- 最大值：16384 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.0.0 版本开始引入 + +#### slowLogScope +- 说明：慢查询记录类型 +- 取值范围：ALL/QUERY/INSERT/OTHERS/NONE +- 默认值：QUERY +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.0.0 版本开始引入 + +#### slowLogExceptDb +- 说明：指定的数据库不上报慢查询，仅支持配置换一个数据库 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.0.0 版本开始引入 + +#### debugFlag +- 说明：运行日志开关，该参数的设置会影响所有模块的开关，后设置的参数起效 +- 类型：整数 +- 取值范围：131（输出错误和警告日志），135（输出错误、警告和调试日志），143（输出错误、警告、调试和跟踪日志） +- 默认值：131 或 135 （取决于不同模块） +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### tmrDebugFlag +- 说明：定时器模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### uDebugFlag +- 说明：共用功能模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### rpcDebugFlag +- 说明：rpc 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### qDebugFlag +- 说明：query 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### dDebugFlag +- 说明：dnode 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### vDebugFlag +- 说明：vnode 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### mDebugFlag +- 说明：mnode 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### azDebugFlag +- 说明：S3 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### sDebugFlag +- 说明：sync 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### tsdbDebugFlag +- 说明：tsdb 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### tqDebugFlag +- 说明：tq 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + + +#### fsDebugFlag +- 说明：fs 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### udfDebugFlag +- 说明：udf 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### smaDebugFlag +- 说明：sma 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### idxDebugFlag +- 说明：index 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### tdbDebugFlag +- 说明：tdb 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### metaDebugFlag +- 说明：meta 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### stDebugFlag +- 说明：stream 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### sndDebugFlag +- 说明：snode 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + ### 调试相关 -|参数名称|支持版本|动态修改|参数含义| -|--------------------|-------------------------|----------|-| -|enableCoreFile | |支持动态修改 立即生效 |crash 时是否生成 core 文件，0：不生成，1：生成；默认值 1| -|configDir | |不支持动态修改 |配置文件所在目录| -|forceReadConfig | |不支持动态修改 |强制使用配置文件中的参数，0:使用持久化的配置参数，1:使用配置文件中的配置参数；默认值 0| -|scriptDir | |不支持动态修改 |内部测试工具的脚本目录| -|assert | |不支持动态修改 |断言控制开关，默认值 0| -|randErrorChance | |支持动态修改 立即生效 |内部参数，用于随机失败测试| -|randErrorDivisor | |支持动态修改 立即生效 |内部参数，用于随机失败测试| -|randErrorScope | |支持动态修改 立即生效 |内部参数，用于随机失败测试| -|safetyCheckLevel | |支持动态修改 立即生效 |内部参数，用于随机失败测试| -|experimental | |支持动态修改 立即生效 |内部参数，用于一些实验特性| -|simdEnable |3.3.4.3 后|不支持动态修改 |内部参数，用于测试 SIMD 加速| -|AVX512Enable |3.3.4.3 后|不支持动态修改 |内部参数，用于测试 AVX512 加速| -|rsyncPort | |不支持动态修改 |内部参数，用于调试流计算| -|snodeAddress | |支持动态修改 重启生效 |内部参数，用于调试流计算| -|checkpointBackupDir | |支持动态修改 重启生效 |内部参数，用于恢复 snode 数据| -|enableAuditDelete | |不支持动态修改 |内部参数，用于测试审计功能| -|slowLogThresholdTest| |不支持动态修改 |内部参数，用于测试慢日志| -|bypassFlag |3.3.4.5 后|支持动态修改 立即生效 |内部参数，用于短路测试，0：正常写入，1：写入消息在 taos 客户端发送 RPC 消息前返回，2：写入消息在 taosd 服务端收到 RPC 消息后返回，4：写入消息在 taosd 服务端写入内存缓存前返回，8：写入消息在 taosd 服务端数据落盘前返回；默认值 0| + +#### enableCoreFile +- 说明：crash 时是否生成 core 文件 +- 类型：整数；0：不生成，1：生成； +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### configDir +- 说明：配置文件所在目录 +- 类型：字符串 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### forceReadConfig +- 说明：配置文件所在目录 +- 类型：整数；0:使用持久化的配置参数，1:使用配置文件中的配置参数； +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：不支持 +- 支持版本：从 v3.3.5.0 版本开始引入 + +#### scriptDir +- 说明：测试工具的脚本目录 `内部参数` +- 类型：字符串 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### assert +- 说明：断言控制开关 +- 类型：整数；0:关闭，1：开启 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### randErrorChance +- 说明：用于随机失败测试 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### randErrorDivisor +- 说明：用于随机失败测试 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### randErrorScope +- 说明：用于随机失败测试 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### safetyCheckLevel +- 说明：用于随机失败测试 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### experimental +- 说明：用于一些实验特性 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### simdEnable +- 说明：用于测试 SIMD 加速 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### AVX512Enable +- 说明：用于测试 AVX512 加速 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### rsyncPort +- 说明：用于调试流计算 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### snodeAddress +- 说明：用于调试流计算 `内部参数` +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### checkpointBackupDir +- 说明：用于恢复 snode 数据 `内部参数` +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### enableAuditDelete +- 说明：用于测试审计功能 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### slowLogThresholdTest +- 说明：用于测试慢日志 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### bypassFlag +- 说明：配置文件所在目录 +- 类型：整数； +- 取值范围：0：正常写入，1：写入消息在 taos 客户端发送 RPC 消息前返回，2：写入消息在 taosd 服务端收到 RPC 消息后返回，4：写入消息在 taosd 服务端写入内存缓存前返回，8：写入消息在 taosd 服务端数据落盘前返回 +- 默认值：0 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.4.5 版本开始引入 ### 压缩参数 -|参数名称|支持版本|动态修改|参数含义| -|------------|----------|-------------------------|-| -|fPrecision | |支持动态修改 立即生效 |设置 float 类型浮点数压缩精度 ，取值范围 0.1 ~ 0.00000001 ，默认值 0.00000001 , 小于此值的浮点数尾数部分将被截断| -|dPrecision | |支持动态修改 立即生效 |设置 double 类型浮点数压缩精度 , 取值范围 0.1 ~ 0.0000000000000001 ， 默认值 0.0000000000000001 ， 小于此值的浮点数尾数部分将被截取| -|lossyColumn |3.3.0.0 前|不支持动态修改 |对 float 和/或 double 类型启用 TSZ 有损压缩；取值范围 float/double/none；默认值 none，表示关闭无损压缩| -|ifAdtFse | |支持动态修改 重启生效 |在启用 TSZ 有损压缩时，使用 FSE 算法替换 HUFFMAN 算法，FSE 算法压缩速度更快，但解压稍慢，追求压缩速度可选用此算法；0：关闭，1：打开；默认值为 0| -|maxRange | |支持动态修改 重启生效 |内部参数，用于有损压缩设置| -|curRange | |支持动态修改 重启生效 |内部参数，用于有损压缩设置| -|compressor | |支持动态修改 重启生效 |内部参数，用于有损压缩设置| + +#### fPrecision +- 说明：设置 float 类型浮点数压缩精度, 小于此值的浮点数尾数部分将被截断 +- 类型：浮点数 +- 默认值：0.00000001 +- 最小值：0.00000001 +- 最大值：0.1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### dPrecision +- 说明：设置 double 类型浮点数压缩精度，小于此值的浮点数尾数部分将被截取 +- 类型：浮点数 +- 默认值：0.0000000000000001 +- 最小值：0.0000000000000001 +- 最大值：0.1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### lossyColumn +- 说明：对 float 和/或 double 类型启用 TSZ 有损压缩 +- 取值范围：float/double/none +- 默认值：none，表示关闭无损压缩 +- 动态修改：不支持 +- 支持版本：从 v3.3.0.0 前支持 + +#### ifAdtFse +- 说明：在启用 TSZ 有损压缩时，使用 FSE 算法替换 HUFFMAN 算法，FSE 算法压缩速度更快，但解压稍慢，追求压缩速度可选用此算法 +- 类型：整数：0：关闭，1：打开 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### maxRange +- 说明：用于有损压缩设置 `内部参数` +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### curRange +- 说明：用于有损压缩设置 `内部参数` +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### compressor +- 说明：用于有损压缩设置 `内部参数` +- 动态修改：支持通过 SQL 修改，重启生效 +- 支持版本：从 v3.1.0.0 版本开始引入 **补充说明** 1. 在 3.3.5.0 之后，所有配置参数都将被持久化到本地存储，重启数据库服务后，将默认使用持久化的配置参数列表；如果您希望继续使用 config 文件中配置的参数，需设置 forceReadConfig 为 1。 diff --git a/docs/zh/14-reference/01-components/02-taosc.md b/docs/zh/14-reference/01-components/02-taosc.md index 46b8854d27..09235557c8 100755 --- a/docs/zh/14-reference/01-components/02-taosc.md +++ b/docs/zh/14-reference/01-components/02-taosc.md @@ -9,102 +9,504 @@ 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 版本开始引入 ### 查询相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------------|----------|-------------------------|-------------| -|countAlwaysReturnValue | |支持动态修改 立即生效 |count/hyperloglog 函数在输入数据为空或者 NULL 的情况下是否返回值；0：返回空行，1：返回；默认值 1；该参数设置为 1 时，如果查询中含有 INTERVAL 子句或者该查询使用了 TSMA 时，且相应的组或窗口内数据为空或者 NULL，对应的组或窗口将不返回查询结果；注意此参数客户端和服务端值应保持一致| -|keepColumnName | |支持动态修改 立即生效 |Last、First、LastRow 函数查询且未指定别名时，自动设置别名为列名（不含函数名），因此 order by 子句如果引用了该列名将自动引用该列对应的函数；1：表示自动设置别名为列名(不包含函数名)，0：表示不自动设置别名；缺省值：0| -|multiResultFunctionStarReturnTags|3.3.3.0 后|支持动态修改 立即生效 |查询超级表时，last(\*)/last_row(\*)/first(\*) 是否返回标签列；查询普通表、子表时，不受该参数影响；0：不返回标签列，1：返回标签列；缺省值：0；该参数设置为 0 时，last(\*)/last_row(\*)/first(\*) 只返回超级表的普通列；为 1 时，返回超级表的普通列和标签列| -|metaCacheMaxSize | |支持动态修改 立即生效 |指定单个客户端元数据缓存大小的最大值，单位 MB；缺省值 -1，表示无限制| -|maxTsmaCalcDelay | |支持动态修改 立即生效 |查询时客户端可允许的 tsma 计算延迟，若 tsma 的计算延迟大于配置值，则该 TSMA 将不会被使用；取值范围 600s - 86400s，即 10 分钟 - 1 小时；缺省值：600 秒| -|tsmaDataDeleteMark | |支持动态修改 立即生效 |TSMA 计算的历史数据中间结果保存时间，单位为毫秒；取值范围 >= 3600000，即大于等于1h；缺省值：86400000，即 1d | -|queryPolicy | |支持动态修改 立即生效 |查询语句的执行策略，1：只使用 vnode，不使用 qnode；2：没有扫描算子的子任务在 qnode 执行，带扫描算子的子任务在 vnode 执行；3：vnode 只运行扫描算子，其余算子均在 qnode 执行；缺省值：1| -|queryTableNotExistAsEmpty | |支持动态修改 立即生效 |查询表不存在时是否返回空结果集；false：返回错误；true：返回空结果集；缺省值 false| -|querySmaOptimize | |支持动态修改 立即生效 |sma index 的优化策略，0：表示不使用 sma index，永远从原始数据进行查询；1：表示使用 sma index，对符合的语句，直接从预计算的结果进行查询；缺省值：0| -|queryPlannerTrace | |支持动态修改 立即生效 |内部参数，查询计划是否输出详细日志| -|queryNodeChunkSize | |支持动态修改 立即生效 |内部参数，查询计划的块大小| -|queryUseNodeAllocator | |支持动态修改 立即生效 |内部参数，查询计划的分配方法| -|queryMaxConcurrentTables | |不支持动态修改 |内部参数，查询计划的并发数目| -|enableQueryHb | |支持动态修改 立即生效 |内部参数，是否发送查询心跳消息| -|minSlidingTime | |支持动态修改 立即生效 |内部参数，sliding 的最小允许值| -|minIntervalTime | |支持动态修改 立即生效 |内部参数，interval 的最小允许值| + +#### countAlwaysReturnValue +- 说明：count/hyperloglog 函数在输入数据为空或者 NULL 的情况下是否返回值；该参数设置为 1 时，如果查询中含有 INTERVAL 子句或者该查询使用了 TSMA 时，且相应的组或窗口内数据为空或者 NULL，对应的组或窗口将不返回查询结果；注意此参数客户端和服务端值应保持一致 +- 类型：整数；0：返回空行，1：返回 +- 最小值：0 +- 最大值：1 +- 默认值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### keepColumnName +- 说明：Last、First、LastRow 函数查询且未指定别名时，自动设置别名为列名（不含函数名），因此 order by 子句如果引用了该列名将自动引用该列对应的函数 +- 类型：整数；1：表示自动设置别名为列名(不包含函数名)，0：表示不自动设置别名 +- 最小值：0 +- 最大值：1 +- 默认值：0 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### multiResultFunctionStarReturnTags +- 说明：查询超级表时，last(\*)/last_row(\*)/first(\*) 是否返回标签列；查询普通表、子表时，不受该参数影响； +- 类型：整数；0：不返回标签列，1：返回标签列；该参数设置为 0 时，last(\*)/last_row(\*)/first(\*) 只返回超级表的普通列；为 1 时，返回超级表的普通列和标签列 +- 最小值：0 +- 最大值：1 +- 默认值：0 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.3.0 版本开始引入 + +#### metaCacheMaxSize +- 说明：指定单个客户端元数据缓存大小的最大值 +- 类型：整数；0：不返回标签列，1：返回标签列；该参数设置为 0 时，last(\*)/last_row(\*)/first(\*) 只返回超级表的普通列；为 1 时，返回超级表的普通列和标签列 +- 单位：MB +- 最小值：-1 +- 最大值：2147483647 +- 默认值：-1 表示无限制 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### maxTsmaCalcDelay +- 说明：查询时客户端可允许的 tsma 计算延迟，若 tsma 的计算延迟大于配置值，则该 TSMA 将不会被使用 +- 类型：整数 +- 单位：秒 +- 最小值：600 +- 最大值：86400 +- 默认值：600 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### tsmaDataDeleteMark +- 说明：TSMA 计算的历史数据中间结果保存时间 +- 类型：整数 +- 单位：毫秒 +- 最小值：3600000 +- 最大值：9223372036854775807 +- 默认值：86400000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryPolicy +- 说明：查询语句的执行策略 +- 类型：整数；1：只使用 vnode，不使用 qnode；2：没有扫描算子的子任务在 qnode 执行，带扫描算子的子任务在 vnode 执行；3：vnode 只运行扫描算子，其余算子均在 qnode 执行； +- 单位：秒 +- 默认值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryTableNotExistAsEmpty +- 说明：查询表不存在时是否返回空结果集 +- 类型：布尔；false：返回错误；true：返回空结果集 +- 默认值：false +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### querySmaOptimize +- 说明：querSmaOptimize，永远从原始数据进行查询 +- 类型：整数 ；1：表示使用 sma index，对符合的语句，直接从预计算的结果进行查询 +- 默认值：false +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryPlannerTrace +- 说明：查询计划是否输出详细日志 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryNodeChunkSize +- 说明：查询计划的块大小 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryUseNodeAllocator +- 说明：查询计划的分配方法 `内部参数` +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### queryMaxConcurrentTables +- 说明：查询计划的并发数目 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### enableQueryHb +- 说明：是否发送查询心跳消息 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### minSlidingTime +- 说明：sliding 的最小允许值 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### minIntervalTime +- 说明：interval 的最小允许值 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.0.0.0 版本开始引入 ### 写入相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------------|----------|-------------------------|-------------| -|smlChildTableName | |支持动态修改 立即生效 |schemaless 自定义的子表名的 key，无缺省值| -|smlAutoChildTableNameDelimiter| |支持动态修改 立即生效 |schemaless tag 之间的连接符，连起来作为子表名，无缺省值| -|smlTagName | |支持动态修改 立即生效 |schemaless tag 为空时默认的 tag 名字，缺省值 "_tag_null"| -|smlTsDefaultName | |支持动态修改 立即生效 |schemaless 自动建表的时间列名字通过该配置设置，缺省值 "_ts"| -|smlDot2Underline | |支持动态修改 立即生效 |schemaless 把超级表名中的 dot 转成下划线| -|maxInsertBatchRows | |支持动态修改 立即生效 |内部参数，一批写入的最大条数| + +#### smlChildTableName +- 说明：schemaless 自定义的子表名的 key +- 默认值：无 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### smlAutoChildTableNameDelimiter +- 说明：schemaless tag 之间的连接符，连起来作为子表名 +- 默认值：无 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### smlTagName +- 说明：schemaless tag 为空时默认的 tag 名字 +- 默认值："_tag_null" +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### smlTsDefaultName +- 说明：schemaless 自动建表的时间列名字通过该配置设置 +- 默认值："_ts" +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### smlDot2Underline +- 说明：schemaless 把超级表名中的 dot 转成下划线 +- 默认值：true +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 + +#### maxInsertBatchRows +- 说明：一批写入的最大条数 +- 默认值：1000000 +- 最小值：1 +- 最大值：2147483647 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.0.0.0 版本开始引入 ### 区域相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------------|----------|-------------------------|-------------| -|timezone | |支持动态修改 立即生效 |时区；缺省从系统中动态获取当前的时区设置| -|locale | |支持动态修改 立即生效 |系统区位信息及编码格式，缺省从系统中获取| -|charset | |支持动态修改 立即生效 |字符集编码，缺省从系统中获取| + +#### timezone +- 说明：时区 +- 默认值：从系统中动态获取当前的时区设置 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### locale +- 说明：系统区位信息及编码格式 +- 默认值：从系统中获取 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### charset +- 说明：字符集编码 +- 默认值：从系统中获取 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 ### 存储相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------------|----------|-------------------------|-------------| -|tempDir | |支持动态修改 立即生效 |指定所有运行过程中的临时文件生成的目录，Linux 平台默认值为 /tmp| -|minimalTmpDirGB | |支持动态修改 立即生效 |tempDir 所指定的临时文件目录所需要保留的最小空间，单位 GB，缺省值：1| + +#### tempDir +- 说明：指定所有运行过程中的临时文件生成的目录 +- 默认值：Linux 平台默认值为 /tmp +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### minimalTmpDirGB +- 说明：tempDir 所指定的临时文件目录所需要保留的最小空间 +- 类型：浮点数 +- 单位：GB +- 默认值：1 +- 最小值：0.001f +- 最大值：10000000 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 ### 日志相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------------|----------|-------------------------|-------------| -|logDir | |不支持动态修改 |日志文件目录，运行日志将写入该目录，缺省值：/var/log/taos| -|minimalLogDirGB | |支持动态修改 立即生效 |日志文件夹所在磁盘可用空间大小小于该值时，停止写日志，单位 GB，缺省值：1| -|numOfLogLines | |支持动态修改 立即生效 |单个日志文件允许的最大行数，缺省值：10,000,000| -|asyncLog | |支持动态修改 立即生效 |日志写入模式，0：同步，1：异步，缺省值：1| -|logKeepDays | |支持动态修改 立即生效 |日志文件的最长保存时间，单位：天，缺省值：0，意味着无限保存，日志文件不会被重命名，也不会有新的日志文件滚动产生，但日志文件的内容有可能会不断滚动，取决于日志文件大小的设置；当设置为大于 0 的值时，当日志文件大小达到设置的上限时会被重命名为 taoslogx.yyy，其中 yyy 为日志文件最后修改的时间戳，并滚动产生新的日志文件| -|debugFlag | |支持动态修改 立即生效 |运行日志开关，131（输出错误和警告日志），135（输出错误、警告和调试日志），143（输出错误、警告、调试和跟踪日志）；默认值 131 或 135 （取决于不同模块）| -|tmrDebugFlag | |支持动态修改 立即生效 |定时器模块的日志开关，取值范围同上| -|uDebugFlag | |支持动态修改 立即生效 |共用功能模块的日志开关，取值范围同上| -|rpcDebugFlag | |支持动态修改 立即生效 |rpc 模块的日志开关，取值范围同上| -|jniDebugFlag | |支持动态修改 立即生效 |jni 模块的日志开关，取值范围同上| -|qDebugFlag | |支持动态修改 立即生效 |query 模块的日志开关，取值范围同上| -|cDebugFlag | |支持动态修改 立即生效 |客户端模块的日志开关，取值范围同上| -|simDebugFlag | |支持动态修改 立即生效 |内部参数，测试工具的日志开关，取值范围同上| -|tqClientDebugFlag|3.3.4.3 后|支持动态修改 立即生效 |客户端模块的日志开关，取值范围同上| + +#### logDir +- 说明：日志文件目录，运行日志将写入该目录 +- 类型：字符串 +- 默认值：/var/log/taos +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### minimalLogDirGB +- 说明：日志文件夹所在磁盘可用空间大小小于该值时，停止写日志 +- 类型：浮点数 +- 单位：GB +- 默认值：1 +- 最小值：0.001f +- 最大值：10000000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### numOfLogLines +- 说明：单个日志文件允许的最大行数 +- 类型：整数 +- 默认值：10,000,000 +- 最小值：1000 +- 最大值：2000000000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### asyncLog +- 说明：日志写入模式 +- 类型：整数；0：同步，1：异步 +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### logKeepDays +- 说明：日志文件的最长保存时间，小于等于0意味着只有两个日志文件相互切换保存日志，超过两个文件保存数量的日志会被删除；当设置为大于 0 的值时，当日志文件大小达到设置的上限时会被重命名为 taosdlog.yyy，其中 yyy 为日志文件最后修改的时间戳，并滚动产生新的日志文件 +- 类型：整数；0 +- 单位：天 +- 默认值：0 +- 最小值：-365000 +- 最大值：365000 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### debugFlag +- 说明：运行日志开关，该参数的设置会影响所有模块的开关，后设置的参数起效 +- 类型：整数 +- 取值范围：131（输出错误和警告日志），135（输出错误、警告和调试日志），143（输出错误、警告、调试和跟踪日志） +- 默认值：131 或 135 （取决于不同模块） +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### tmrDebugFlag +- 说明：定时器模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### uDebugFlag +- 说明：共用功能模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### rpcDebugFlag +- 说明：rpc 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### jniDebugFlag +- 说明：jni 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### qDebugFlag +- 说明：query 模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### cDebugFlag +- 说明：客户端模块的日志开关 +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### simDebugFlag +- 说明：测试工具的日志开关 `内部参数` +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### tqClientDebugFlag +- 说明：测试工具的日志开关 `内部参数` +- 类型：整数 +- 取值范围：同上 +- 默认值：131 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 ### 调试相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------------|----------|-------------------------|-------------| -|crashReporting | |支持动态修改 立即生效 |是否上传 crash 到 telemetry，0：不上传，1：上传；缺省值：1| -|enableCoreFile | |支持动态修改 立即生效 |crash 时是否生成 core 文件，0：不生成，1：生成；缺省值：1| -|assert | |不支持动态修改 |断言控制开关，缺省值：0| -|configDir | |不支持动态修改 |配置文件所在目录| -|scriptDir | |不支持动态修改 |内部参数，测试用例的目录| -|randErrorChance |3.3.3.0 后|不支持动态修改 |内部参数，用于随机失败测试| -|randErrorDivisor |3.3.3.0 后|不支持动态修改 |内部参数，用于随机失败测试| -|randErrorScope |3.3.3.0 后|不支持动态修改 |内部参数，用于随机失败测试| -|safetyCheckLevel |3.3.3.0 后|不支持动态修改 |内部参数，用于随机失败测试| -|simdEnable |3.3.4.3 后|不支持动态修改 |内部参数，用于测试 SIMD 加速| -|AVX512Enable |3.3.4.3 后|不支持动态修改 |内部参数，用于测试 AVX512 加速| -|bypassFlag |3.3.4.5 后|支持动态修改 立即生效 |内部参数，用于短路测试，0：正常写入，1：写入消息在 taos 客户端发送 RPC 消息前返回，2：写入消息在 taosd 服务端收到 RPC 消息后返回，4：写入消息在 taosd 服务端写入内存缓存前返回，8：写入消息在 taosd 服务端数据落盘前返回；缺省值：0| + +#### crashReporting +- 说明：是否上传 crash 到 telemetry +- 类型：整数；0：不上传，1：上传； +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### enableCoreFile +- 说明：crash 时是否生成 core 文件 +- 类型：整数；0：不生成，1：生成； +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### assert +- 说明：断言控制开关 +- 类型：整数；0:关闭，1：开启 +- 默认值：0 +- 最小值：0 +- 最大值：1 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### configDir +- 说明：配置文件所在目录 +- 类型：字符串 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 + +#### scriptDir +- 说明：测试工具的脚本目录 `内部参数` +- 类型：字符串 +- 动态修改：不支持 +- 支持版本：从 v3.3.3.0 版本开始引入 + +#### randErrorChance +- 说明：用于随机失败测试 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.3.3.0 版本开始引入 + +#### randErrorDivisor +- 说明：用于随机失败测试 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.3.3.0 版本开始引入 + +#### randErrorScope +- 说明：用于随机失败测试 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.3.3.0 版本开始引入 + +#### safetyCheckLevel +- 说明：用于随机失败测试 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.3.3.0 版本开始引入 + +#### simdEnable +- 说明：用于测试 SIMD 加速 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### AVX512Enable +- 说明：用于测试 AVX512 加速 `内部参数` +- 动态修改：不支持 +- 支持版本：从 v3.3.4.3 版本开始引入 + +#### bypassFlag +- 说明：配置文件所在目录 +- 类型：整数； +- 取值范围：0：正常写入，1：写入消息在 taos 客户端发送 RPC 消息前返回，2：写入消息在 taosd 服务端收到 RPC 消息后返回，4：写入消息在 taosd 服务端写入内存缓存前返回，8：写入消息在 taosd 服务端数据落盘前返回 +- 默认值：0 +- 动态修改：支持通过 SQL 修改，立即生效 +- 支持版本：从 v3.3.4.5 版本开始引入 ### SHELL 相关 -|参数名称|支持版本|动态修改|参数含义| -|----------------------|----------|-------------------------|-------------| -|enableScience | |不支持动态修改 |是否开启科学计数法显示浮点数；0：不开始，1：开启；缺省值：1| + +#### enableScience +- 说明：是否开启科学计数法显示浮点数 +- 类型：整数；0：不开始，1：开启； +- 默认值：1 +- 最小值：0 +- 最大值：1 +- 动态修改：不支持 +- 支持版本：从 v3.1.0.0 版本开始引入 ## API