From 73050d71bb733ad88e15e6caeae1370315c4c00f Mon Sep 17 00:00:00 2001 From: gccgdb1234 Date: Fri, 29 Jul 2022 17:57:50 +0800 Subject: [PATCH] doc: correct errors in configuration --- docs/zh/14-reference/12-config/index.md | 231 +++++++++++++++--------- 1 file changed, 141 insertions(+), 90 deletions(-) diff --git a/docs/zh/14-reference/12-config/index.md b/docs/zh/14-reference/12-config/index.md index fefb50c541..845693a98e 100644 --- a/docs/zh/14-reference/12-config/index.md +++ b/docs/zh/14-reference/12-config/index.md @@ -1,6 +1,6 @@ --- title: 配置参数 -description: 'TDengine 客户端和服务配置列表' +description: "TDengine 客户端和服务配置列表" --- ## 为服务端指定配置文件 @@ -21,8 +21,6 @@ taosd -C TDengine 系统的前台交互客户端应用程序为 taos，以及应用驱动，它可以与 taosd 共享同一个配置文件 taos.cfg，也可以使用单独指定配置文件。运行 taos 时，使用参数-c 指定配置文件目录，如 taos -c /home/cfg，表示使用/home/cfg/目录下的 taos.cfg 配置文件中的参数，缺省目录是/etc/taos。更多 taos 的使用方法请见帮助信息 `taos --help`。 -**2.0.10.0 之后版本支持命令行以下参数显示当前客户端参数的配置** - ```bash taos -C ``` @@ -47,19 +45,19 @@ taos --dump-config ### firstEp -| 属性 | 说明 | -| -------- | --------------------------------------------------------------- | -| 适用范围 | 服务端和客户端均适用 | +| 属性 | 说明 | +| -------- | -------------------------------------------------------------- | +| 适用范围 | 服务端和客户端均适用 | | 含义 | taosd 或者 taos 启动时，主动连接的集群中首个 dnode 的 endpoint | -| 缺省值 | localhost:6030 | +| 缺省值 | localhost:6030 | ### secondEp -| 属性 | 说明 | -| -------- | -------------------------------------------------------------------------------------- | -| 适用范围 | 服务端和客户端均适用 | +| 属性 | 说明 | +| -------- | ------------------------------------------------------------------------------------- | +| 适用范围 | 服务端和客户端均适用 | | 含义 | taosd 或者 taos 启动时，如果 firstEp 连接不上，尝试连接集群中第二个 dnode 的 endpoint | -| 缺省值 | 无 | +| 缺省值 | 无 | ### fqdn @@ -77,7 +75,6 @@ taos --dump-config | 适用范围 | 仅服务端适用 | | 含义 | taosd 启动后，对外服务的端口号 | | 缺省值 | 6030 | -| 补充说明 | RESTful 服务在 2.4.0.0 之前（不含）由 taosd 提供，默认端口为 6041; 在 2.4.0.0 及后续版本由 taosAdapter，默认端口为 6041 | :::note 确保集群中所有主机在端口 6030 上的 TCP 协议能够互通。（详细的端口情况请参见下表） @@ -87,8 +84,8 @@ taos --dump-config | TCP | 6030 | 客户端与服务端之间通讯，多节点集群的节点间通讯。 | 由配置文件设置 serverPort 决定。 | | TCP | 6041 | 客户端与服务端之间的 RESTful 通讯。 | 随 serverPort 端口变化。注意 taosAdapter 配置或有不同，请参考相应[文档](/reference/taosadapter/)。 | | TCP | 6043 | TaosKeeper 监控服务端口。 | 随 TaosKeeper 启动参数设置变化。 | -| TCP | 6044 | 支持 StatsD 的数据接入端口。 | 随 taosAdapter 启动参数设置变化（2.3.0.1+以上版本）。 | -| UDP | 6045 | 支持 collectd 数据接入端口。 | 随 taosAdapter 启动参数设置变化（2.3.0.1+以上版本）。 | +| TCP | 6044 | 支持 StatsD 的数据接入端口。 | 随 taosAdapter 启动参数设置变化| +| UDP | 6045 | 支持 collectd 数据接入端口。 | 随 taosAdapter 启动参数设置变化 | | TCP | 6060 | 企业版内 Monitor 服务的网络端口。 | | ### maxShellConns @@ -104,28 +101,28 @@ taos --dump-config ### monitor -| 属性 | 说明 | -| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 适用范围 | 仅服务端适用 | | 含义 | 服务器内部的系统监控开关。监控主要负责收集物理节点的负载状况，包括 CPU、内存、硬盘、网络带宽的监控记录，监控信息将通过 HTTP 协议发送给由 `monitorFqdn` 和 `monitorProt` 指定的 TaosKeeper 监控服务 | -| 取值范围 | 0：关闭监控服务， 1：激活监控服务。 | -| 缺省值 | 1 | +| 取值范围 | 0：关闭监控服务， 1：激活监控服务。 | +| 缺省值 | 1 | ### monitorFqdn -| 属性 | 说明 | -| -------- | -------------------------------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | -------------------------- | +| 适用范围 | 仅服务端适用 | | 含义 | TaosKeeper 监控服务的 FQDN | -| 缺省值 | 无 | +| 缺省值 | 无 | ### monitorPort -| 属性 | 说明 | -| -------- | -------------------------------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | --------------------------- | +| 适用范围 | 仅服务端适用 | | 含义 | TaosKeeper 监控服务的端口号 | -| 缺省值 | 6043 | +| 缺省值 | 6043 | ### monitorInterval @@ -134,10 +131,9 @@ taos --dump-config | 适用范围 | 仅服务端适用 | | 含义 | 监控数据库记录系统参数（CPU/内存）的时间间隔 | | 单位 | 秒 | -| 取值范围 | 1-200000 | +| 取值范围 | 1-200000 | | 缺省值 | 30 | - ### telemetryReporting | 属性 | 说明 | @@ -149,25 +145,43 @@ taos --dump-config ## 查询相关 -### queryBufferSize +### queryPolicy + +| 属性 | 说明 | +| -------- | ----------------------------- | +| 适用范围 | 仅客户端适用 | +| 含义 | 查询语句的执行策略 | +| 单位 | 无 | +| 缺省值 | 1 | +| 补充说明 | 1: 只使用 vnode，不使用 qnode | + +2: 没有扫描算子的子任务在 qnode 执行，带扫描算子的子任务在 vnode 执行 + +3: vnode 只运行扫描算子，其余算子均在 qnode 执行 | + +### querySmaOptimize + +| 属性 | 说明 | +| -------- | -------------------- | +| 适用范围 | 仅客户端适用 | +| 含义 | sma index 的优化策略 | +| 单位 | 无 | +| 缺省值 | 0 | +| 补充说明 | + +0: 表示不使用 sma index，永远从原始数据进行查询 + +1: 表示使用 sma index，对符合的语句，直接从预计算的结果进行查询 | -| 属性 | 说明 | -| -------- | ------------------------------------------------------------------------------------------------------------------- | -| 适用范围 | 仅服务端适用 | -| 含义 | 为所有并发查询占用保留的内存大小。 | -| 单位 | MB | -| 缺省值 | 无 | -| 补充说明 | 计算规则可以根据实际应用可能的最大并发数和表的数字相乘，再乘 170 。
（2.0.15 以前的版本中，此参数的单位是字节） | ### maxNumOfDistinctRes | 属性 | 说明 | -| -------- | -------------------------------- | +| -------- | -------------------------------- | --- | | 适用范围 | 仅服务端适用 | | 含义 | 允许返回的 distinct 结果最大行数 | | 取值范围 | 默认值为 10 万，最大值 1 亿 | | 缺省值 | 10 万 | -| 补充说明 | 2.3 版本新增。 | | ## 区域相关 @@ -306,12 +320,12 @@ charset 的有效值是 UTF-8。 ### supportVnodes -| 属性 | 说明 | -| -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| 适用范围 | 仅服务端适用 | -| 含义 | dnode 支持的最大 vnode 数目 | -| 取值范围 | 0-4096 | -| 缺省值 | 256 | +| 属性 | 说明 | +| -------- | --------------------------- | +| 适用范围 | 仅服务端适用 | +| 含义 | dnode 支持的最大 vnode 数目 | +| 取值范围 | 0-4096 | +| 缺省值 | 256 | ## 时间相关 @@ -366,7 +380,6 @@ charset 的有效值是 UTF-8。 | 单位 | bytes | | 取值范围 | 0: 对所有查询结果均进行压缩 >0: 查询结果中任意列大小超过该值的消息才进行压缩 -1: 不压缩 | | 缺省值 | -1 | -| 补充说明 | 2.3.0.0 版本新增。 | ## 日志相关 @@ -464,7 +477,7 @@ charset 的有效值是 UTF-8。 | 属性 | 说明 | | -------- | -------------------- | | 适用范围 | 服务端和客户端均适用 | -| 含义 | query 模块的日志开关 | +| 含义 | query 模块的日志开关 | | 取值范围 | 同上 | | 缺省值 | | @@ -481,7 +494,7 @@ charset 的有效值是 UTF-8。 | 属性 | 说明 | | -------- | -------------------- | -| 适用范围 | 仅服务端适用 | +| 适用范围 | 仅服务端适用 | | 含义 | dnode 模块的日志开关 | | 取值范围 | 同上 | | 缺省值 | 135 | @@ -490,28 +503,28 @@ charset 的有效值是 UTF-8。 | 属性 | 说明 | | -------- | -------------------- | -| 适用范围 | 仅服务端适用 | +| 适用范围 | 仅服务端适用 | | 含义 | vnode 模块的日志开关 | | 取值范围 | 同上 | | 缺省值 | | ### mDebugFlag -| 属性 | 说明 | -| -------- | ------------------ | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | -------------------- | +| 适用范围 | 仅服务端适用 | | 含义 | mnode 模块的日志开关 | -| 取值范围 | 同上 | -| 缺省值 | 135 | +| 取值范围 | 同上 | +| 缺省值 | 135 | ### wDebugFlag -| 属性 | 说明 | -| -------- | -------------------- | -| 适用范围 | 仅服务端适用 | -| 含义 | wal 模块的日志开关 | -| 取值范围 | 同上 | -| 缺省值 | 135 | +| 属性 | 说明 | +| -------- | ------------------ | +| 适用范围 | 仅服务端适用 | +| 含义 | wal 模块的日志开关 | +| 取值范围 | 同上 | +| 缺省值 | 135 | ### sDebugFlag @@ -533,57 +546,86 @@ charset 的有效值是 UTF-8。 ### tqDebugFlag -| 属性 | 说明 | -| -------- | ------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ----------------- | +| 适用范围 | 仅服务端适用 | | 含义 | tq 模块的日志开关 | -| 取值范围 | 同上 | -| 缺省值 | | +| 取值范围 | 同上 | +| 缺省值 | | ### fsDebugFlag -| 属性 | 说明 | -| -------- | ------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ----------------- | +| 适用范围 | 仅服务端适用 | | 含义 | fs 模块的日志开关 | -| 取值范围 | 同上 | -| 缺省值 | | +| 取值范围 | 同上 | +| 缺省值 | | ### udfDebugFlag -| 属性 | 说明 | -| -------- | ---------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ------------------ | +| 适用范围 | 仅服务端适用 | | 含义 | UDF 模块的日志开关 | -| 取值范围 | 同上 | -| 缺省值 | | +| 取值范围 | 同上 | +| 缺省值 | | ### smaDebugFlag -| 属性 | 说明 | -| -------- | ---------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ------------------ | +| 适用范围 | 仅服务端适用 | | 含义 | sma 模块的日志开关 | -| 取值范围 | 同上 | -| 缺省值 | | +| 取值范围 | 同上 | +| 缺省值 | | ### idxDebugFlag -| 属性 | 说明 | -| -------- | ---------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | -------------------- | +| 适用范围 | 仅服务端适用 | | 含义 | index 模块的日志开关 | -| 取值范围 | 同上 | -| 缺省值 | | +| 取值范围 | 同上 | +| 缺省值 | | ### tdbDebugFlag -| 属性 | 说明 | -| -------- | ---------------------- | -| 适用范围 | 仅服务端适用 | +| 属性 | 说明 | +| -------- | ------------------ | +| 适用范围 | 仅服务端适用 | | 含义 | tdb 模块的日志开关 | -| 取值范围 | 同上 | -| 缺省值 | | +| 取值范围 | 同上 | +| 缺省值 | | + +## Schemaless 相关 + +### smlChildTableName + +| 属性 | 说明 | +| -------- | ------------------------- | +| 适用范围 | 仅客户端适用 | +| 含义 | schemaless 自定义的子表名 | +| 类型 | 字符串 | +| 缺省值 | 无 | + +### smlTagName + +| 属性 | 说明 | +| -------- | ------------------------------------ | +| 适用范围 | 仅客户端适用 | +| 含义 | schemaless tag 为空时默认的 tag 名字 | +| 类型 | 字符串 | +| 缺省值 | _tag_null | + +### smlDataFormat + +| 属性 | 说明 | +| -------- | ----------------------------- | +| 适用范围 | 仅客户端适用 | +| 含义 | schemaless 列数据是否顺序一致 | +| 值域 | 0：不一致；1: 一致 | +| 缺省值 | 1 | ## 其他 @@ -596,3 +638,12 @@ charset 的有效值是 UTF-8。 | 取值范围 | 0：否，1：是 | | 缺省值 | 1 | | 补充说明 | 不同的启动方式，生成 core 文件的目录如下：1、systemctl start taosd 启动：生成的 core 在根目录下
2、手动启动，就在 taosd 执行目录下。 | + +### udf + +| 属性 | 说明 | +| -------- | ------------------ | +| 适用范围 | 仅服务端适用 | +| 含义 | 是否启动 udf 服务 | +| 取值范围 | 0: 不启动；1：启动 | +| 缺省值 | 1 |