From 3fcc669e7aaee2e4a8ae8f0e035df70e4d8741cc Mon Sep 17 00:00:00 2001 From: Shengliang Guan Date: Tue, 12 Nov 2024 18:18:14 +0800 Subject: [PATCH] docs: update taosc config --- .../zh/14-reference/01-components/01-taosd.md | 283 +++++++++--------- .../zh/14-reference/01-components/02-taosc.md | 69 +++-- 2 files changed, 176 insertions(+), 176 deletions(-) diff --git a/docs/zh/14-reference/01-components/01-taosd.md b/docs/zh/14-reference/01-components/01-taosd.md index 95b942ef66..dc35d40b07 100644 --- a/docs/zh/14-reference/01-components/01-taosd.md +++ b/docs/zh/14-reference/01-components/01-taosd.md @@ -28,59 +28,57 @@ 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 | |待补充| -|numOfRpcSessions | |允许一个 dnode 能发起的最大连接数，取值范围 100-100000，缺省值：30000| -|numOfRpcThreads | |待补充| -|numOfTaskQueueThreads | |待补充| -|timeToGetAvailableConn | |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，缺省值：500000| -|maxRetryWaitTime | |待补充| -|shareConnLimit | |待补充| -|readTimeout | |待补充| -|keepAliveIdle | |待补充| -|maxShellConns | |允许创建的最大链接数| +|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 线程数目，默认值为 CPU 核数的一半| +|numOfTaskQueueThreads | |dnode 处理 RPC 消息的线程数| |statusInterval | |dnode 与 mnode 之间的心跳间隔| -|rpcQueueMemoryAllowed | |dnode 允许的 rpc 消息占用的内存最大值，单位 bytes，取值范围：104857600-INT64_MAX，缺省值：服务器内存的 1/10 | +|rpcQueueMemoryAllowed | |dnode 允许的 rpc 消息占用的内存最大值，单位 bytes，取值范围 104857600-INT64_MAX，默认值 服务器内存的 1/10 | |resolveFQDNRetryTime | |FQDN 解析失败时的重试次数| +|timeToGetAvailableConn | |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，默认值 500000| +|maxShellConns | |允许创建的最大链接数| +|maxRetryWaitTime | |重连最大超时时间| +|shareConnLimit |3.3.4.3 之后|内部参数，一个链接可以共享的查询数目，取值范围 1-256，默认值 10| +|readTimeout |3.3.4.3 之后|内部参数，最小超时时间，取值范围 64-604800，单位为秒，默认值 900| ### 监控相关 |参数名称|支持版本|参数含义| |-----------------------|-----------|-| -|monitor | |是否收集监控数据并上报，0: 关闭；1:打开；缺省值：0| -|monitorFqdn | |taosKeeper 服务所在服务器的 FQDN，缺省值：无| -|monitorPort | |taosKeeper 服务所监听的端口号，缺省值：6043| -|monitorInternal | |监控数据库记录系统参数（CPU/内存）的时间间隔，单位是秒，取值范围 1-200000 ，缺省值：30| +|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| +|telemetryReporting | |是否上传 telemetry，0：不上传，1：上传，默认值 1| |telemetryServer | |telemetry 服务器地址| |telemetryPort | |telemetry 服务器端口编号| |telemetryInterval | |telemetry 上传时间间隔，单位为秒，默认 43200| -|crashReporting | |是否上传 crash 信息；0: 不上传，1: 上传；缺省值： 1| +|crashReporting | |是否上传 crash 信息；0：不上传，1：上传；默认值 1| ### 查询相关 |参数名称|支持版本|参数含义| -|----------------------------------|-----------|-| -|countAlwaysReturnValue | |count/hyperloglog 函数在输入数据为空或者 NULL 的情况下是否返回值；0：返回空行，1：返回；缺省值 1；该参数设置为 1 时，如果查询中含有 INTERVAL 子句或者该查询使用了 TSMA 时，且相应的组或窗口内数据为空或者 NULL，对应的组或窗口将不返回查询结果；注意此参数客户端和服务端值应保持一致| -|enableQueryHb | |待补充| -|tagFilterCache | |待补充| -|maxNumOfDistinctRes | |允许返回的 distinct 结果最大行数，默认值 10 万，最大允许值 1 亿| -|queryBufferSize | |待补充| -|queryRspPolicy | |待补充| -|queryPlannerTrace | |待补充| -|queryNodeChunkSize | |待补充| -|queryUseNodeAllocator | |待补充| -|queryMaxConcurrentTable| |待补充| -|cacheLazyLoadThreshold | |待补充| -|queryRsmaTolerance | |待补充| -|filterScalarMode | |待补充| - +|------------------------|-----------|-| +|countAlwaysReturnValue | |count/hyperloglog 函数在输入数据为空或者 NULL 的情况下是否返回值；0：返回空行，1：返回；默认值 1；该参数设置为 1 时，如果查询中含有 INTERVAL 子句或者该查询使用了 TSMA 时，且相应的组或窗口内数据为空或者 NULL，对应的组或窗口将不返回查询结果；注意此参数客户端和服务端值应保持一致| +|tagFilterCache | |是否缓存标签过滤结果| +|maxNumOfDistinctRes | |允许返回的 distinct 结果最大行数，默认值 10 万，最大允许值 1 亿| +|queryBufferSize | |暂不生效| +|queryRspPolicy | |查询响应策略| +|filterScalarMode | |强制使用标量过滤模式，0：关闭；1：开启，默认值 0| +|queryPlannerTrace | |内部参数，查询计划是否输出详细日志| +|queryNodeChunkSize | |内部参数，查询计划的块大小| +|queryUseNodeAllocator | |内部参数，查询计划的分配方法| +|queryMaxConcurrentTables| |内部参数，查询计划的并发数目| +|queryRsmaTolerance | |内部参数，用于判定查询哪一级 rsma 数据时的容忍时间，单位为毫秒| +|enableQueryHb | |内部参数，是否发送查询心跳消息| +|pqSortMemThreshold | |内部参数，排序使用的内存阈值| ### 区域相关 |参数名称|支持版本|参数含义| @@ -127,7 +125,7 @@ SELECT count(*) FROM table_name WHERE TS<1554984068000; 客户端的输入的字符均采用操作系统当前默认的编码格式，在 Linux/macOS 系统上多为 UTF-8，部分中文系统编码则可能是 GB18030 或 GBK 等。在 docker 环境中默认的编码是 POSIX。在中文版 Windows 系统中，编码则是 CP936。客户端需要确保正确设置自己所使用的字符集，即客户端运行的操作系统当前编码字符集，才能保证 nchar 中的数据正确转换为 UCS4-LE 编码格式。 -在 Linux/macOS 中 locale 的命名规则为: \<语言>_\<地区>.\<字符集编码> 如：zh_CN.UTF-8，zh 代表中文，CN 代表大陆地区，UTF-8 表示字符集。字符集编码为客户端正确解析本地字符串提供编码转换的说明。Linux/macOS 可以通过设置 locale 来确定系统的字符编码，由于 Windows 使用的 locale 中不是 POSIX 标准的 locale 格式，因此在 Windows 下需要采用另一个配置参数 charset 来指定字符编码。在 Linux/macOS 中也可以使用 charset 来指定字符编码。 +在 Linux/macOS 中 locale 的命名规则为：\<语言>_\<地区>.\<字符集编码> 如：zh_CN.UTF-8，zh 代表中文，CN 代表大陆地区，UTF-8 表示字符集。字符集编码为客户端正确解析本地字符串提供编码转换的说明。Linux/macOS 可以通过设置 locale 来确定系统的字符编码，由于 Windows 使用的 locale 中不是 POSIX 标准的 locale 格式，因此在 Windows 下需要采用另一个配置参数 charset 来指定字符编码。在 Linux/macOS 中也可以使用 charset 来指定字符编码。 3. 如果配置文件中不设置 charset，在 Linux/macOS 中，taos 在启动时候，自动读取系统当前的 locale 信息，并从 locale 信息中解析提取 charset 编码格式。如果自动读取 locale 信息失败，则尝试读取 charset 配置，如果读取 charset 配置也失败，则中断启动过程。 @@ -167,94 +165,96 @@ charset 的有效值是 UTF-8。 ### 存储相关 |参数名称|支持版本|参数含义| |--------------------|-----------|-| -|dataDir | |数据文件目录，所有的数据文件都将写入该目录，缺省值：/var/lib/taos| -|tempDir | |指定所有系统运行过程中的临时文件生成的目录，缺省值：/tmp| -|minimalDataDirGB | |dataDir 指定的时序数据存储目录所需要保留的最小空间，单位 GB，缺省值: 2| -|minimalTmpDirGB | |tempDir 所指定的临时文件目录所需要保留的最小空间，单位 GB，缺省值: 1| -|minDiskFreeSize |3.1.1.0 之后|当某块磁盘上的可用空间小于等于这个阈值时，该磁盘将不再被选择用于生成新的数据文件，单位为字节，取值范围：52428800-1073741824，默认值为 52428800；企业版参数| -|s3MigrateIntervalSec|3.3.4.3 之后|-| -|s3MigrateEnabled |3.3.4.3 之后|-| -|s3Accesskey |3.3.4.3 之后|-| -|s3Endpoint |3.3.4.3 之后|-| -|s3BucketName |3.3.4.3 之后|-| -|s3PageCacheSize |3.3.4.3 之后|-| -|s3UploadDelaySec |3.3.4.3 之后|-| - +|dataDir | |数据文件目录，所有的数据文件都将写入该目录，默认值 /var/lib/taos| +|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 | |内部参数，缓存的装载策略| ### 集群相关 |参数名称|支持版本|参数含义| |--------------------------|-----------|-| -|supportVnodes | |dnode 支持的最大 vnode 数目，取值范围：0-4096，缺省值：CPU 核数的 2 倍 + 5| -|numOfCommitThreads | |落盘线程的最大数量，取值范围 0-1024，缺省值为 4 | -|numOfMnodeReadThreads | |待补充| -|numOfVnodeQueryThreads | |待补充| -|ratioOfVnodeStreamThreads | |待补充| -|numOfVnodeFetchThreads | |待补充| -|numOfVnodeRsmaThreads | |待补充| -|numOfQnodeQueryThreads | |待补充| -|numOfSnodeSharedThreads | |待补充| -|numOfSnodeUniqueThreads | |待补充| -|numOfMnodeReadThreads | |待补充| -|ttlUnit | |待补充| -|ttlPushInterval | |待补充| -|ttlBatchDropNum | |待补充| -|ttlChangeOnWrite | |ttl 到期时间是否伴随表的修改操作改变; 0: 不改变，1：改变；默认值为 0| -|ttlFlushThreshold | |待补充| -|compactPullupInterval | |待补充| -|walFsyncDataSizeLimit | |待补充| -|retentionSpeedLimitMB | |待补充| -|syncElectInterval | |待补充| -|syncHeartbeatInterval | |待补充| -|syncHeartbeatTimeout | |待补充| -|syncSnapReplMaxWaitN | |待补充| -|syncLogBufferMemoryAllowed| |一个 dnode 允许的 sync 日志缓存消息占用的内存最大值，单位 bytes，取值范围：104857600-INT64_MAX，缺省值：服务器内存的 1/10，3.1.3.2/3.3.2.13 版本开始生效 | -|arbHeartBeatIntervalSec | |待补充| -|arbCheckSyncIntervalSec | |待补充| -|arbSetAssignedTimeoutSec | |待补充| -|maxTsmaNum | |集群内可创建的TSMA个数；取值范围：0-3；缺省值为 3| -|tmqMaxTopicNum | |订阅最多可建立的 topic 数量; 取值范围 1-10000；缺省值为 20| -|tmqRowSize | |订阅数据块的最大记录条数| -|audit | |审计功能开关0；企业版参数| -|auditInterval | |审计数据上报的时间间隔0；企业版参数| -|auditCreateTable | |是否针对创建子表开启申计功能0；企业版参数| +|supportVnodes | |dnode 支持的最大 vnode 数目，取值范围 0-4096，默认值 CPU 核数的 2 倍 + 5| +|numOfCommitThreads | |落盘线程的最大数量，取值范围 0-1024，默认值为 4| +|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 | |白名单功能开关；企业版参数| -|mndSdbWriteDelta | |待补充| -|mndLogRetention | |待补充| -|skipGrant | |待补充| -|trimVDbIntervalSec | |待补充| -|uptimeInterval | |待补充| -|timeseriesThreshold | |待补充| -|udf | |是否启动 UDF 服务；0: 不启动，1：启动；默认值为 0 | -|udfdResFuncs | |待补充| -|udfdLdLibPath | |待补充| -|pqSortMemThreshold | |待补充| +|syncLogBufferMemoryAllowed| |一个 dnode 允许的 sync 日志缓存消息占用的内存最大值，单位 bytes，取值范围 104857600-INT64_MAX，默认值 服务器内存的 1/10，3.1.3.2/3.3.2.13 版本开始生效 | +|syncElectInterval | |内部参数，用于同步模块调试| +|syncHeartbeatInterval | |内部参数，用于同步模块调试| +|syncHeartbeatTimeout | |内部参数，用于同步模块调试| +|syncSnapReplMaxWaitN | |内部参数，用于同步模块调试| +|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 装载的库路径| ### 流计算参数 |参数名称|支持版本|参数含义| |-----------------------|-----------|-| -|disableStream | |待补充| -|streamBufferSize | |待补充| -|streamAggCnt | |待补充| -|checkpointInterval | |待补充| -|streamSinkDataRaterMode| |待补充| -|syncSnapReplMaxWaitN | |待补充| +|disableStream | |流计算的启动开关| +|streamBufferSize | |控制内存中窗口状态缓存的大小，默认值为 128MB| +|streamAggCnt | |内部参数，并发进行聚合计算的数目| +|checkpointInterval | |内部参数，checkponit 同步间隔| +|concurrentCheckpoint | |内部参数，是否并发检查 checkpoint| +|maxStreamBackendCache | |内部参数，流计算使用的最大缓存| +|streamSinkDataRate | |内部参数，用于控制流计算结果的写入速度| ### 日志相关 |参数名称|支持版本|参数含义| |----------------|-----------|-| -|logDir | |日志文件目录，运行日志将写入该目录，缺省值：/var/log/taos| -|minimalLogDirGB | |日志文件夹所在磁盘可用空间大小小于该值时，停止写日志，单位 GB，缺省值：1| -|numOfLogLines | |单个日志文件允许的最大行数，缺省值：10,000,000| -|asyncLog | |日志写入模式，0：同步，1：异步，缺省值：1| -|logKeepDays | |日志文件的最长保存时间，单位：天，缺省值：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| +|logDir | |日志文件目录，运行日志将写入该目录，默认值 /var/log/taos| +|minimalLogDirGB | |日志文件夹所在磁盘可用空间大小小于该值时，停止写日志，单位 GB，默认值 1| +|numOfLogLines | |单个日志文件允许的最大行数，默认值 10,000,000| +|asyncLog | |日志写入模式，0：同步，1：异步，默认值 1| +|logKeepDays | |日志文件的最长保存时间，单位：天，默认值 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 （取决于不同模块）| +|debugFlag | |运行日志开关，131（输出错误和警告日志），135（输出错误、警告和调试日志），143（输出错误、警告、调试和跟踪日志）；默认值 131 或 135 （取决于不同模块）| |tmrDebugFlag | |定时器模块的日志开关，取值范围同上| |uDebugFlag | |共用功能模块的日志开关，取值范围同上| |rpcDebugFlag | |rpc 模块的日志开关，取值范围同上| @@ -278,32 +278,33 @@ charset 的有效值是 UTF-8。 ### 调试相关 |参数名称|支持版本|参数含义| |--------------------|-----------|-| -|enableCoreFile | |crash 时是否生成 core 文件，0：不生成，1：生成；缺省值：1| +|enableCoreFile | |crash 时是否生成 core 文件，0：不生成，1：生成；默认值 1| |configDir | |配置文件所在目录| |scriptDir | |内部测试工具的脚本目录| -|assert | |断言控制开关，缺省值：0| -|randErrorChance | |内部参数| -|randErrorDivisor | |内部参数| -|randErrorScope | |内部参数| -|safetyCheckLevel | |内部参数| -|experimental | |内部参数| +|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| |内部参数，用于测试慢日志| +|rsyncPort | |内部参数，用于调试流计算| +|snodeAddress | |内部参数，用于调试流计算| +|checkpointBackupDir | |内部参数，用于恢复 snode 数据| +|enableAuditDelete | |内部参数，用于测试审计功能| +|slowLogThresholdTest| |内部参数，用于测试慢日志| ### 压缩参数 |参数名称|支持版本|参数含义| |------------|-----------|-| -|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 | |待补充| +|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 | |内部参数，用于有损压缩设置| **补充说明** 1. 在 3.2.0.0 ~ 3.3.0.0（不包含）版本生效，启用该参数后不能回退到升级前的版本 @@ -370,7 +371,7 @@ taosd 会将监控指标上报给 taosKeeper，这些监控指标会被 taosKeep | :------------- | :-------- | :------ | :--------------------------------------------- | | \_ts | TIMESTAMP | | timestamp | | tables\_num | DOUBLE | | vgroup 中 table 数量 | -| status | DOUBLE | | vgroup 状态, 取值范围：unsynced = 0, ready = 1 | +| status | DOUBLE | | vgroup 状态, 取值范围 unsynced = 0, ready = 1 | | vgroup\_id | VARCHAR | TAG | vgroup id | | database\_name | VARCHAR | TAG | vgroup 所属的 database 名字 | | cluster\_id | VARCHAR | TAG | cluster id | @@ -399,10 +400,10 @@ taosd 会将监控指标上报给 taosKeeper，这些监控指标会被 taosKeep | io\_write\_disk | DOUBLE | | 磁盘 io 吞吐率，从 `/proc//io` 中读取的 write_bytes。单位 byte/s | | vnodes\_num | DOUBLE | | dnode 上 vnodes 数量 | | masters | DOUBLE | | dnode 上 master node 数量 | -| has\_mnode | DOUBLE | | dnode 是否包含 mnode，取值范围：包含=1,不包含=0 | -| has\_qnode | DOUBLE | | dnode 是否包含 qnode，取值范围：包含=1,不包含=0 | -| has\_snode | DOUBLE | | dnode 是否包含 snode，取值范围：包含=1,不包含=0 | -| has\_bnode | DOUBLE | | dnode 是否包含 bnode，取值范围：包含=1,不包含=0 | +| has\_mnode | DOUBLE | | dnode 是否包含 mnode，取值范围 包含=1,不包含=0 | +| has\_qnode | DOUBLE | | dnode 是否包含 qnode，取值范围 包含=1,不包含=0 | +| has\_snode | DOUBLE | | dnode 是否包含 snode，取值范围 包含=1,不包含=0 | +| has\_bnode | DOUBLE | | dnode 是否包含 bnode，取值范围 包含=1,不包含=0 | | error\_log\_count | DOUBLE | | error 总数 | | info\_log\_count | DOUBLE | | info 总数 | | debug\_log\_count | DOUBLE | | debug 总数 | @@ -418,7 +419,7 @@ taosd 会将监控指标上报给 taosKeeper，这些监控指标会被 taosKeep | field | type | is\_tag | comment | | :---------- | :-------- | :------ | :--------------------------------------- | | \_ts | TIMESTAMP | | timestamp | -| status | DOUBLE | | dnode 状态,取值范围：ready=1，offline =0 | +| status | DOUBLE | | dnode 状态,取值范围 ready=1，offline =0 | | dnode\_id | VARCHAR | TAG | dnode id | | dnode\_ep | VARCHAR | TAG | dnode endpoint | | cluster\_id | VARCHAR | TAG | cluster id | @@ -461,7 +462,7 @@ taosd 会将监控指标上报给 taosKeeper，这些监控指标会被 taosKeep | field | type | is\_tag | comment | | :---------- | :-------- | :------ | :------------------------------------------------------------------------------------------------------- | | \_ts | TIMESTAMP | | timestamp | -| role | DOUBLE | | mnode 角色， 取值范围：offline = 0,follower = 100,candidate = 101,leader = 102,error = 103,learner = 104 | +| role | DOUBLE | | mnode 角色， 取值范围 offline = 0,follower = 100,candidate = 101,leader = 102,error = 103,learner = 104 | | mnode\_id | VARCHAR | TAG | master node id | | mnode\_ep | VARCHAR | TAG | master node endpoint | | cluster\_id | VARCHAR | TAG | cluster id | @@ -473,7 +474,7 @@ taosd 会将监控指标上报给 taosKeeper，这些监控指标会被 taosKeep | field | type | is\_tag | comment | | :------------- | :-------- | :------ | :------------------------------------------------------------------------------------------------------ | | \_ts | TIMESTAMP | | timestamp | -| vnode\_role | DOUBLE | | vnode 角色，取值范围：offline = 0,follower = 100,candidate = 101,leader = 102,error = 103,learner = 104 | +| vnode\_role | DOUBLE | | vnode 角色，取值范围 offline = 0,follower = 100,candidate = 101,leader = 102,error = 103,learner = 104 | | vgroup\_id | VARCHAR | TAG | dnode id | | dnode\_id | VARCHAR | TAG | dnode id | | database\_name | VARCHAR | TAG | vgroup 所属的 database 名字 | @@ -487,9 +488,9 @@ taosd 会将监控指标上报给 taosKeeper，这些监控指标会被 taosKeep | :---------- | :-------- | :------ | :--------------------------------------- | | \_ts | TIMESTAMP | | timestamp | | count | DOUBLE | | sql 数量 | -| result | VARCHAR | TAG | sql的执行结果，取值范围：Success, Failed | +| result | VARCHAR | TAG | sql的执行结果，取值范围 Success, Failed | | username | VARCHAR | TAG | 执行sql的user name | -| sql\_type | VARCHAR | TAG | sql类型，取值范围：inserted_rows | +| sql\_type | VARCHAR | TAG | sql类型，取值范围 inserted_rows | | dnode\_id | VARCHAR | TAG | dnode id | | dnode\_ep | VARCHAR | TAG | dnode endpoint | | vgroup\_id | VARCHAR | TAG | dnode id | @@ -503,9 +504,9 @@ taosd 会将监控指标上报给 taosKeeper，这些监控指标会被 taosKeep | :---------- | :-------- | :------ | :---------------------------------------- | | \_ts | TIMESTAMP | | timestamp | | count | DOUBLE | | sql 数量 | -| result | VARCHAR | TAG | sql的执行结果，取值范围：Success, Failed | +| result | VARCHAR | TAG | sql的执行结果，取值范围 Success, Failed | | username | VARCHAR | TAG | 执行sql的user name | -| sql\_type | VARCHAR | TAG | sql类型，取值范围：select, insert，delete | +| sql\_type | VARCHAR | TAG | sql类型，取值范围 select, insert，delete | | cluster\_id | VARCHAR | TAG | cluster id | ### taos\_slow\_sql 表 @@ -516,9 +517,9 @@ taosd 会将监控指标上报给 taosKeeper，这些监控指标会被 taosKeep | :---------- | :-------- | :------ | :---------------------------------------------------- | | \_ts | TIMESTAMP | | timestamp | | count | DOUBLE | | sql 数量 | -| result | VARCHAR | TAG | sql的执行结果，取值范围：Success, Failed | +| result | VARCHAR | TAG | sql的执行结果，取值范围 Success, Failed | | username | VARCHAR | TAG | 执行sql的user name | -| duration | VARCHAR | TAG | sql执行耗时，取值范围：3-10s,10-100s,100-1000s,1000s- | +| duration | VARCHAR | TAG | sql执行耗时，取值范围 3-10s,10-100s,100-1000s,1000s- | | cluster\_id | VARCHAR | TAG | cluster id | ## 日志相关 diff --git a/docs/zh/14-reference/01-components/02-taosc.md b/docs/zh/14-reference/01-components/02-taosc.md index e1901dd876..6c70687a99 100755 --- a/docs/zh/14-reference/01-components/02-taosc.md +++ b/docs/zh/14-reference/01-components/02-taosc.md @@ -14,45 +14,44 @@ TDengine 客户端驱动提供了应用编程所需要的全部 API，并且在 |firstEp | |启动时，主动连接的集群中首个 dnode 的 endpoint，缺省值：hostname:6030，若无法获取该服务器的 hostname，则赋值为 localhost| |secondEp | |启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint，没有缺省值| |compressMsgSize | |是否对 RPC 消息进行压缩；-1：所有消息都不压缩；0：所有消息都压缩；N (N>0)：只有大于 N 个字节的消息才压缩；缺省值 -1| -|shellActivityTimer | || -|numOfRpcSessions | |允许一个客户端发起的最大连接数，取值范围 100-100000，缺省值：30000| -|numOfRpcThreads | || -|numOfTaskQueueThreads | || -|timeToGetAvailableConn| |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，缺省值：500000| -|maxRetryWaitTime | || -|useAdapter | |内部参数，不需设置| -|shareConnLimit | || -|readTimeout | || -|keepAliveIdle | || +|shellActivityTimer | |客户端向 mnode 发送心跳的时长，单位为秒，取值范围 1-120，默认值 3| +|numOfRpcSessions | |RPC 支持的最大连接数，取值范围 100-100000，缺省值 30000| +|numOfRpcThreads | |RPC 线程数目，默认值为 CPU 核数的一半| +|timeToGetAvailableConn| |获得可用连接的最长等待时间，取值范围 10-50000000，单位为毫秒，缺省值 500000| +|useAdapter | |内部参数，是否使用 taosadapter，影响 CSV 文件导入| +|shareConnLimit |3.3.4.3 之后|内部参数，一个链接可以共享的查询数目，取值范围 1-256，默认值 10| +|readTimeout |3.3.4.3 之后|内部参数，最小超时时间，取值范围 64-604800，单位为秒，默认值 900| ### 查询相关 |参数名称|支持版本|参数含义| |---------------------------------|-----------|-| +|countAlwaysReturnValue | |count/hyperloglog 函数在输入数据为空或者 NULL 的情况下是否返回值；0：返回空行，1：返回；默认值 1；该参数设置为 1 时，如果查询中含有 INTERVAL 子句或者该查询使用了 TSMA 时，且相应的组或窗口内数据为空或者 NULL，对应的组或窗口将不返回查询结果；注意此参数客户端和服务端值应保持一致| |keepColumnName | |Last、First、LastRow 函数查询且未指定别名时，自动设置别名为列名（不含函数名），因此 order by 子句如果引用了该列名将自动引用该列对应的函数；1：表示自动设置别名为列名(不包含函数名)，0：表示不自动设置别名；缺省值：0| |multiResultFunctionStarReturnTags| |查询超级表时，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 | +| + | |指定单个客户端元数据缓存大小的最大值，单位 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 | || -|minIntervalTime | || +|queryPlannerTrace | |内部参数，查询计划是否输出详细日志| +|queryNodeChunkSize | |内部参数，查询计划的块大小| +|queryUseNodeAllocator | |内部参数，查询计划的分配方法| +|queryMaxConcurrentTables | |内部参数，查询计划的并发数目| +|enableQueryHb | |内部参数，是否发送查询心跳消息| +|minSlidingTime | |内部参数，sliding 的最小允许值| +|minIntervalTime | |内部参数，interval 的最小允许值| ### 写入相关 |参数名称|支持版本|参数含义| |------------------------------|-----------|-| -|maxInsertBatchRows | || |smlChildTableName | |schemaless 自定义的子表名的 key，无缺省值| |smlAutoChildTableNameDelimiter| |schemaless tag 之间的连接符，连起来作为子表名，无缺省值| |smlTagName | |schemaless tag 为空时默认的 tag 名字，缺省值 "_tag_null"| -|smlTsDefaultName | |schemaless自动建表的时间列名字通过该配置设置，缺省值 "_ts"| +|smlTsDefaultName | |schemaless 自动建表的时间列名字通过该配置设置，缺省值 "_ts"| |smlDot2Underline | |schemaless 把超级表名中的 dot 转成下划线| +|maxInsertBatchRows | |内部参数，一批写入的最大条数| ### 区域相关 |参数名称|支持版本|参数含义| @@ -64,7 +63,7 @@ TDengine 客户端驱动提供了应用编程所需要的全部 API，并且在 ### 存储相关 |参数名称|支持版本|参数含义| |-----------------|-----------|-| -|tempDir | |指定所有运行过程中的临时文件生成的目录，Linux 下缺省值为 /tmp| +|tempDir | |指定所有运行过程中的临时文件生成的目录，Linux 平台默认值为 /tmp| |minimalTmpDirGB | |tempDir 所指定的临时文件目录所需要保留的最小空间，单位 GB，缺省值：1| ### 日志相关 @@ -75,29 +74,29 @@ TDengine 客户端驱动提供了应用编程所需要的全部 API，并且在 |numOfLogLines | |单个日志文件允许的最大行数，缺省值：10,000,000| |asyncLog | |日志写入模式，0：同步，1：异步，缺省值：1| |logKeepDays | |日志文件的最长保存时间，单位：天，缺省值：0，意味着无限保存，日志文件不会被重命名，也不会有新的日志文件滚动产生，但日志文件的内容有可能会不断滚动，取决于日志文件大小的设置；当设置为大于 0 的值时，当日志文件大小达到设置的上限时会被重命名为 taoslogx.yyy，其中 yyy 为日志文件最后修改的时间戳，并滚动产生新的日志文件| -|debugFlag | |运行日志开关，131（输出错误和警告日志），135（输出错误、警告和调试日志），143（输出错误、警告、调试和跟踪日志）；默认值：131 或 135 （取决于不同模块）| +|debugFlag | |运行日志开关，131（输出错误和警告日志），135（输出错误、警告和调试日志），143（输出错误、警告、调试和跟踪日志）；默认值 131 或 135 （取决于不同模块）| |tmrDebugFlag | |定时器模块的日志开关，取值范围同上| |uDebugFlag | |共用功能模块的日志开关，取值范围同上| |rpcDebugFlag | |rpc 模块的日志开关，取值范围同上| |jniDebugFlag | |jni 模块的日志开关，取值范围同上| |cDebugFlag | |客户端模块的日志开关，取值范围同上| -|tqClientDebugFlag| |客户端模块的日志开关，取值范围同上| -|simDebugFlag | |内部测试工具的日志开关，取值范围同上| +|simDebugFlag | |内部参数，测试工具的日志开关，取值范围同上| +|tqClientDebugFlag|3.3.4.3 之后|客户端模块的日志开关，取值范围同上| ### 调试相关 |参数名称|支持版本|参数含义| |-----------------|-----------|-| -|crashReporting | |是否上传 telemetry，0：不上传，1：上传；缺省值：1| +|crashReporting | |是否上传 crash 到 telemetry，0：不上传，1：上传；缺省值：1| |enableCoreFile | |crash 时是否生成 core 文件，0：不生成，1：生成；缺省值：1| -|configDir | |配置文件所在目录| -|scriptDir | |内部测试工具的脚本目录| |assert | |断言控制开关，缺省值：0| -|randErrorChance | |内部参数| -|randErrorDivisor | |内部参数| -|randErrorScope | |内部参数| -|safetyCheckLevel | |内部参数| -|simdEnable | |是否启动 SIMD 加速| -|AVX512Enable | |是否启动 AVX512 加速| +|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 加速| ### SHELL 相关 |参数名称|支持版本|参数含义|