08-server-config.md 61.8 KB
Newer Older
D
dingbo 已提交
1
---
2
title: 配置参数
D
dingbo 已提交
3
---
B
Bo Ding 已提交
4

5 6
## 为服务端指定配置文件

D
dingbo 已提交
7
TDengine 系统后台服务由 taosd 提供,可以在配置文件 taos.cfg 里修改配置参数,以满足不同场景的需求。配置文件的缺省位置在/etc/taos 目录,可以通过 taosd 命令行执行参数 -c 指定配置文件目录。比如,指定配置文件位于`/home/user` 这个目录:
B
Bo Ding 已提交
8

D
dingbo 已提交
9 10 11 12 13
```
taosd -c /home/user
```

另外可以使用 `-C` 显示当前服务器配置参数:
B
Bo Ding 已提交
14 15 16 17 18

```
taosd -C
```

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
## 为客户端指定配置文件

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
```

```bash
taos --dump-config
```

# 配置参数详细列表

:::note
本节内容覆盖产品的配置参数,适用于服务端的参数按其对产品行为的影响进行分类,这其中有部分参数也同时适用于客户端;但有少量参数仅适用于客户端,这部分参数进行了单独归类。

:::

B
Bo Ding 已提交
40 41 42

:::note
配置文件参数修改后,需要重启*taosd*服务,或客户端应用才能生效。
D
dingbo 已提交
43

B
Bo Ding 已提交
44 45
:::

46
## 连接相关
D
dingbo 已提交
47

48
### firstEp
D
dingbo 已提交
49 50 51 52

| 属性     | 说明                                                  |
| -------- | ----------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                                  |
53
| 含义     | taosd 或者 taos 启动时,主动连接的集群中首个 dnode 的 end point |
D
dingbo 已提交
54 55
| 缺省值   | localhost:6030                                        |

56 57 58 59 60 61 62 63
### secondEP

| 属性     | 说明                                                                         |
| -------- | ---------------------------------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                                                         |
| 含义     | taosd 或者 taos 启动时,如果 firstEp 连接不上,尝试连接集群中第二个 dnode 的 end point |
| 缺省值   | 无                                                                           |

D
dingbo 已提交
64 65 66 67
### fqdn

| 属性     | 说明                                                              |
| -------- | ----------------------------------------------------------------- |
68
| 适用范围 | 仅服务端适用                                              |
D
dingbo 已提交
69 70 71 72 73
| 含义     | 数据节点的 FQDN。如果习惯 IP 地址访问,可设置为该节点的 IP 地址。 |
| 缺省值   | 缺省为操作系统配置的第一个 hostname。                             |
| 补充说明 | 这个参数值的长度需要控制在 96 个字符以内。                        |

### serverPort
B
Bo Ding 已提交
74 75 76

| 属性     | 说明                                                                                                                |
| -------- | ------------------------------------------------------------------------------------------------------------------- |
77
| 适用范围 | 仅服务端适用                                                                                                |
D
dingbo 已提交
78 79
| 含义     | taosd 启动后,对外服务的端口号                                                                                      |
| 缺省值   | 6030                                                                                                                |
80
| 补充说明 | RESTful 服务在2.4.0.0之前(不含)由taosd提供,默认端口为 6041; 在2.4.0.0 及后续版本由 taosAdapter,默认端口为6041 |
D
dingbo 已提交
81 82

:::note
83
对于端口,TDengine 会使用从 serverPort 起 13 个连续的 TCP 和 UDP 端口号,请务必在防火墙打开。因此如果是缺省配置,需要打开从 6030 到 6042 共 13 个端口,而且必须 TCP 和 UDP 都打开。(详细的端口情况请参见下表)
D
dingbo 已提交
84
:::
85 86 87 88 89 90 91 92 93
| 协议 | 默认端口  | 用途说明                            | 修改方法                                                                                                                           |
| :--- | :-------- | :---------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- |
| TCP  | 6030      | 客户端与服务端之间通讯。            | 由配置文件设置 serverPort 决定。                                                                                                   |
| TCP  | 6035      | 多节点集群的节点间通讯。            | 随 serverPort 端口变化。                                                                                                           |
| TCP  | 6040      | 多节点集群的节点间数据同步。        | 随 serverPort 端口变化。                                                                                                           |
| TCP  | 6041      | 客户端与服务端之间的 RESTful 通讯。 | 随 serverPort 端口变化。注意 taosAdapter 配置或有不同,请参考相应[文档](https://www.taosdata.com/cn/documentation/tools/adapter)。 |
| TCP  | 6042      | Arbitrator 的服务端口。             | 随 Arbitrator 启动参数设置变化。                                                                                                   |
| TCP  | 6043      | TaosKeeper 监控服务端口。           | 随 TaosKeeper 启动参数设置变化。                                                                                                   |
| TCP  | 6044      | 支持 StatsD 的数据接入端口。        | 随 taosAdapter 启动参数设置变化(2.3.0.1+以上版本)。                                                                              |
B
Bo Ding 已提交
94
| UDP  | 6045      | 支持 collectd 数据接入端口。        | 随 taosAdapter 启动参数设置变化(2.3.0.1+以上版本)。                                                                              |
95 96 97 98
| TCP  | 6060      | 企业版内 Monitor 服务的网络端口。   |                                                                                                                                    |
| UDP  | 6030-6034 | 客户端与服务端之间通讯。            | 随 serverPort 端口变化。                                                                                                           |
| UDP  | 6035-6039 | 多节点集群的节点间通讯。            | 随 serverPort 端口变化。

99
### maxShellConns
B
Bo Ding 已提交
100

101 102 103 104 105 106
| 属性     | 说明                    |
| -------- | ----------------------- |
| 适用范围 | 仅服务端适用            |
| 含义     | 一个 dnode 容许的连接数 |
| 取值范围 | 10-50000000             |
| 缺省值   | 5000                    |
B
Bo Ding 已提交
107

108
### maxConnections
D
dingbo 已提交
109

110 111 112 113 114 115 116
| 属性     | 说明                                                                            |
| -------- | ------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                    |
| 含义     | 一个数据库连接所容许的 dnode 连接数                                             |
| 取值范围 | 1-100000                                                                        |
| 缺省值   | 5000                                                                            |
| 补充说明 | 实际测试下来,如果默认没有配,选 50 个 worker thread 会产生 Network unavailable |
D
dingbo 已提交
117

118
### rpcForceTcp
D
dingbo 已提交
119

120 121 122 123 124 125 126
| 属性     | 说明                                                |
| -------- | --------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                                |
| 含义     | 强制使用 TCP 传输                                   |
| 取值范围 | 0: 不开启 1: 开启                                   |
| 缺省值   | 0                                                   |
| 补充说明 | 在网络比较差的环境中,建议开启。<br/>2.0 版本新增。 |
D
dingbo 已提交
127

128
## 监控相关
D
dingbo 已提交
129 130 131 132 133 134 135 136 137 138

### monitor

| 属性     | 说明                                                                                                                                           |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                                   |
| 含义     | 服务器内部的系统监控开关。监控主要负责收集物理节点的负载状况,包括 CPU、内存、硬盘、网络带宽、HTTP 请求量的监控记录,记录信息存储在`LOG`库中。 |
| 取值范围 | 0:关闭监控服务, 1:激活监控服务。                                                                                                            |
| 缺省值   | 0                                                                                                                                              |

139 140 141 142 143 144 145 146 147
### monitorInterval

| 属性     | 说明                                         |
| -------- | -------------------------------------------- |
| 适用范围 | 仅服务端适用                                 |
| 含义     | 监控数据库记录系统参数(CPU/内存)的时间间隔 |
| 单位     | 秒                                           |
| 取值范围 | 1-600                                        |
| 缺省值   | 30                                           |
B
Bo Ding 已提交
148 149


150
### telemetryRePorting
B
Bo Ding 已提交
151 152 153 154 155

| 属性     | 说明                                     |
| -------- | ---------------------------------------- |
| 适用范围 | 仅服务端适用                             |
| 含义     | 是否允许 TDengine 采集和上报基本使用信息 |
156
| 取值范围 | 0:不允许        1:允许                  |
B
Bo Ding 已提交
157 158
| 缺省值   | 1                                        |

159
## 查询相关
B
Bo Ding 已提交
160

161
### queryBufferSize
B
Bo Ding 已提交
162

163 164 165 166 167 168 169
| 属性     | 说明                                                                                                                |
| -------- | ------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                        |
| 含义     | 为所有并发查询占用保留的内存大小。                                                                                  |
| 单位     | MB                                                                                                                  |
| 缺省值   | 无 |
| 补充说明 | 计算规则可以根据实际应用可能的最大并发数和表的数字相乘,再乘 170 。<br/>(2.0.15 以前的版本中,此参数的单位是字节) |
B
Bo Ding 已提交
170

171
### ratioOfQueryCores
D
dingbo 已提交
172

173 174 175 176 177 178
| 属性     | 说明                                                                                                                                                                                                    |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| 适用范围 | 仅服务端适用                                                                                                                                                                                            |
| 含义     | 设置查询线程的最大数量。                                                                                                                                                                                |
| 缺省值   |              1  |
| 补充说明 | 最小值 0 表示只有 1 个查询线程 <br/> 最大值 2 表示最大建立 2 倍 CPU 核数的查询线程。<br/>默认为 1,表示最大和 CPU 核数相等的查询线程。<br/>该值可以为小数,即 0.5 表示最大建立 CPU 核数一半的查询线程。 |    
D
dingbo 已提交
179

180 181 182 183 184 185 186 187 188
### maxNumOfDistinctRes

| 属性     | 说明                             |
| -------- | -------------------------------- |
| 适用范围 | 仅服务端适用                     |
| 含义     | 允许返回的 distinct 结果最大行数 |
| 取值范围 | 默认值为 10 万,最大值 1 亿      |
| 缺省值   | 10 万                            |
| 补充说明 | 2.3 版本新增。                   | |
D
dingbo 已提交
189 190 191 192

## 区域相关

### timezone
B
Bo Ding 已提交
193

D
dingbo 已提交
194 195 196 197 198 199
| 属性     | 说明                           |
| -------- | ------------------------------ |
| 适用范围 | 服务端和客户端均适用           |
| 含义     | 时区                           |
| 缺省值   | 从系统中动态获取当前的时区设置 |

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
:::info
为应对多时区的数据写入和查询问题,TDengine 采用 Unix 时间戳(Unix Timestamp)来记录和存储时间戳。Unix 时间戳的特点决定了任一时刻不论在任何时区,产生的时间戳均一致。需要注意的是,Unix 时间戳是在客户端完成转换和记录。为了确保客户端其他形式的时间转换为正确的 Unix 时间戳,需要设置正确的时区。

  在 Linux 系统中,客户端会自动读取系统设置的时区信息。用户也可以采用多种方式在配置文件设置时区。例如:

  ```
  timezone UTC-8
  timezone GMT-8
  timezone Asia/Shanghai
  ```

  均是合法的设置东八区时区的格式。但需注意,Windows 下并不支持 `timezone Asia/Shanghai` 这样的写法,而必须写成 `timezone UTC-8`

  时区的设置对于查询和写入 SQL 语句中非 Unix 时间戳的内容(时间戳字符串、关键词 now 的解析)产生影响。例如:

  ```sql
  SELECT count(*) FROM table_name WHERE TS<'2019-04-11 12:01:08';
  ```

  在东八区,SQL 语句等效于

  ```sql
  SELECT count(*) FROM table_name WHERE TS<1554955268000;
  ```

  在 UTC 时区,SQL 语句等效于

  ```sql
  SELECT count(*) FROM table_name WHERE TS<1554984068000;
  ```

  为了避免使用字符串时间格式带来的不确定性,也可以直接使用 Unix 时间戳。此外,还可以在 SQL 语句中使用带有时区的时间戳字符串,例如:RFC3339 格式的时间戳字符串,2013-04-12T15:52:01.123+08:00 或者 ISO-8601 格式时间戳字符串 2013-04-12T15:52:01.123+0800。上述两个字符串转化为 Unix 时间戳不受系统所在时区的影响。

  启动 taos 时,也可以从命令行指定一个 taosd 实例的 end point,否则就从 taos.cfg 读取。

:::

D
dingbo 已提交
237 238 239 240 241 242 243 244
### locale

| 属性     | 说明                                                                    |
| -------- | ----------------------------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                                                    |
| 含义     | 系统区位信息及编码格式                                                  |
| 缺省值   | 系统中动态获取,如果自动获取失败,需要用户在配置文件设置或通过 API 设置 |

245 246 247 248 249 250 251 252 253
:::info
  TDengine 为存储中文、日文、韩文等非 ASCII 编码的宽字符,提供一种专门的字段类型 nchar。写入 nchar 字段的数据将统一采用 UCS4-LE 格式进行编码并发送到服务器。需要注意的是,编码正确性是客户端来保证。因此,如果用户想要正常使用 nchar 字段来存储诸如中文、日文、韩文等非 ASCII 字符,需要正确设置客户端的编码格式。

  客户端的输入的字符均采用操作系统当前默认的编码格式,在 Linux 系统上多为 UTF-8,部分中文系统编码则可能是 GB18030 或 GBK 等。在 docker 环境中默认的编码是 POSIX。在中文版 Windows 系统中,编码则是 CP936。客户端需要确保正确设置自己所使用的字符集,即客户端运行的操作系统当前编码字符集,才能保证 nchar 中的数据正确转换为 UCS4-LE 编码格式。

  在 Linux 中 locale 的命名规则为: <语言>\_<地区>.<字符集编码> 如:zh_CN.UTF-8,zh 代表中文,CN 代表大陆地区,UTF-8 表示字符集。字符集编码为客户端正确解析本地字符串提供编码转换的说明。Linux 系统与 Mac OSX 系统可以通过设置 locale 来确定系统的字符编码,由于 Windows 使用的 locale 中不是 POSIX 标准的 locale 格式,因此在 Windows 下需要采用另一个配置参数 charset 来指定字符编码。在 Linux 系统中也可以使用 charset 来指定字符编码。

:::

D
dingbo 已提交
254 255 256 257 258 259 260 261
### charset

| 属性     | 说明                                                                    |
| -------- | ----------------------------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                                                    |
| 含义     | 字符集编码                                                              |
| 缺省值   | 系统中动态获取,如果自动获取失败,需要用户在配置文件设置或通过 API 设置 |

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
:::info
如果配置文件中不设置 charset,在 Linux 系统中,taos 在启动时候,自动读取系统当前的 locale 信息,并从 locale 信息中解析提取 charset 编码格式。如果自动读取 locale 信息失败,则尝试读取 charset 配置,如果读取 charset 配置也失败,则中断启动过程。

  在 Linux 系统中,locale 信息包含了字符编码信息,因此正确设置了 Linux 系统 locale 以后可以不用再单独设置 charset。例如:

  ```
  locale zh_CN.UTF-8
  ```

  在 Windows 系统中,无法从 locale 获取系统当前编码。如果无法从配置文件中读取字符串编码信息,taos 默认设置为字符编码为 CP936。其等效在配置文件中添加如下配置:

  ```
  charset CP936
  ```

  如果需要调整字符编码,请查阅当前操作系统使用的编码,并在配置文件中正确设置。

  在 Linux 系统中,如果用户同时设置了 locale 和字符集编码 charset,并且 locale 和 charset 的不一致,后设置的值将覆盖前面设置的值。

  ```
  locale zh_CN.UTF-8
  charset GBK
  ```

  则 charset 的有效值是 GBK。

  ```
  charset GBK
  locale zh_CN.UTF-8
  ```

  charset 的有效值是 UTF-8。

  日志的配置参数,与 server 的配置参数完全一样。

:::

D
dingbo 已提交
299 300
## 存储相关

301 302 303 304 305 306 307 308
### dataDir

| 属性     | 说明                                       |
| -------- | ------------------------------------------ |
| 适用范围 | 仅服务端适用                               |
| 含义     | 数据文件目录,所有的数据文件都将写入该目录 |
| 缺省值   | /var/lib/taos                              |

D
dingbo 已提交
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
### cache

| 属性     | 说明         |
| -------- | ------------ |
| 适用范围 | 仅服务端适用 |
| 含义     | 内存块的大小 |
| 单位     | MB           |
| 缺省值   | 16           |

### blocks

| 属性     | 说明                                                                                                  |
| -------- | ----------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                          |
| 含义     | 每个 vnode(tsdb)中有多少 cache 大小的内存块。因此一个 vnode 的用的内存大小粗略为(cache \* blocks) |
| 缺省值   | 6                                                                                                     |

### days

| 属性     | 说明                       |
| -------- | -------------------------- |
| 适用范围 | 仅服务端适用               |
| 含义     | 数据文件存储数据的时间跨度 |
| 单位     | 天                         |
| 缺省值   | 10                         |

### keep

| 属性     | 说明           |
| -------- | -------------- |
| 适用范围 | 仅服务端适用   |
| 含义     | 数据保留的天数 |
| 单位     | 天             |
| 缺省值   | 3650           |

### minRows

| 属性     | 说明                   |
| -------- | ---------------------- |
| 适用范围 | 仅服务端适用           |
| 含义     | 文件块中记录的最小条数 |
| 缺省值   | 100                    |

### maxRows

| 属性     | 说明                   |
| -------- | ---------------------- |
| 适用范围 | 仅服务端适用           |
| 含义     | 文件块中记录的最大条数 |
| 缺省值   | 4096                   |

### walLevel

| 属性     | 说明                                                      |
| -------- | --------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                              |
| 含义     | WAL 级别                                                  |
| 取值范围 | 1:写 wal, 但不执行 fsync <br/> 2:写 wal, 而且执行 fsync |
| 缺省值   | 1                                                         |

### fsync

| 属性     | 说明                                                                 |
| -------- | -------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                         |
| 含义     | 当 wal 设置为 2 时,执行 fsync 的周期                                |
| 单位     | 毫秒                                                                 |
| 取值范围 | 最小为 0,表示每次写入,立即执行 fsync <br/> 最大为 180000(三分钟) |
| 缺省值   | 3000                                                                 |

### update

| 属性     | 说明                                                                                                                         |
| -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                 |
| 含义     | 允许更新已存在的数据行                                                                                                       |
| 取值范围 | 0:不允许更新 <br/> 1:允许整行更新 <br/> 2:允许部分列更新。(2.1.7.0 版本开始此参数支持设为 2,在此之前取值只能是 [0, 1]) |
| 缺省值   | 0                                                                                                                            |
| 补充说明 | 2.0.8.0 版本之前,不支持此参数。                                                                                             |

### cacheLast

| 属性     | 说明                                                                                                                                                                                             |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 适用范围 | 仅服务端适用                                                                                                                                                                                     |
| 含义     | 是否在内存中缓存子表的最近数据                                                                                                                                                                   |
| 取值范围 | 0:关闭 <br/> 1:缓存子表最近一行数据 <br/> 2:缓存子表每一列的最近的非 NULL 值 <br/> 3:同时打开缓存最近行和列功能。(2.1.2.0 版本开始此参数支持 0 ~ 3 的取值范围,在此之前取值只能是 [0, 1]) |
| 缺省值   | 0                                                                                                                                                                                                |
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
| 补充说明 | 2.1.2.0 版本之前、2.0.20.7 版本之前在 taos.cfg 文件中不支持此参数。 

### minimalTmpDirGB

| 属性     | 说明                                             |
| -------- | ------------------------------------------------ |
| 适用范围 | 服务端和客户端均适用                             |
| 含义     | 当日志文件夹的磁盘大小小于该值时,停止写临时文件 |
| 单位     | GB                                               |
| 缺省值   | 0.1                                              |

### minimalDataDirGB

| 属性     | 说明                                             |
| -------- | ------------------------------------------------ |
| 适用范围 | 仅服务端适用                                     |
| 含义     | 当日志文件夹的磁盘大小小于该值时,停止写时序数据 |
| 单位     | GB                                               |
| 缺省值   | 0.1                                              |
D
dingbo 已提交
416

417 418 419 420 421 422 423 424 425
### vnodeBak

| 属性     | 说明                             |
| -------- | -------------------------------- |
| 适用范围 | 仅服务端适用                     |
| 含义     | 删除 vnode 时是否备份 vnode 目录 |
| 取值范围 | 0:否,1:是                     |
| 缺省值   | 1                                |

D
dingbo 已提交
426 427
## 集群相关

428 429 430 431 432 433 434 435
### numOfMnodes

| 属性     | 说明               |
| -------- | ------------------ |
| 适用范围 | 仅服务端适用       |
| 含义     | 系统中管理节点个数 |
| 缺省值   | 3                  |

436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
### replica

| 属性     | 说明         |
| -------- | ------------ |
| 适用范围 | 仅服务端适用 |
| 含义     | 副本个数     |
| 取值范围 | 1-3          |
| 缺省值   | 1            |

### quorum

| 属性     | 说明                             |
| -------- | -------------------------------- |
| 适用范围 | 仅服务端适用                     |
| 含义     | 多副本环境下指令执行的确认数要求 |
| 取值范围 | 1,2                              |
| 缺省值   | 1                                |

D
dingbo 已提交
454
### role
B
Bo Ding 已提交
455 456 457 458 459 460 461

| 属性     | 说明                                                                                                                                      |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                              |
| 含义     | dnode 的可选角色                                                                                                                          |
| 取值范围 | 0:any(既可作为 mnode,也可分配 vnode) <br/> 1:mgmt(只能作为 mnode,不能分配 vnode) <br/> 2:dnode(不能作为 mnode,只能分配 vnode) |
| 缺省值   | 0                                                                                                                                         |
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
### balance

| 属性     | 说明             |
| -------- | ---------------- |
| 适用范围 | 仅服务端适用     |
| 含义     | 是否启动负载均衡 |
| 取值范围 | 0,1             |
| 缺省值   | 1                |

### balanceInterval

| 属性     | 说明                                             |
| -------- | ------------------------------------------------ |
| 适用范围 | 仅服务端适用                                     |
| 含义     | 管理节点在正常运行状态下,检查负载均衡的时间间隔 |
| 单位     | 秒                                               |
| 取值范围 | 1-30000                                          |
| 缺省值   | 300                                              |

### arbitrator

| 属性     | 说明                     |
| -------- | ------------------------ |
| 适用范围 | 仅服务端适用             |
| 含义     | 系统中裁决器的 end point,其格式如firstEp |
| 缺省值   | 空                       |
B
Bo Ding 已提交
488

D
dingbo 已提交
489
## 时间相关
B
Bo Ding 已提交
490

D
dingbo 已提交
491
### rpcTimer
B
Bo Ding 已提交
492 493 494 495 496 497 498 499 500

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | rpc 重试时长         |
| 单位     | 毫秒                 |
| 取值范围 | 100-3000             |
| 缺省值   | 300                  |

D
dingbo 已提交
501
### rpcMaxTime
B
Bo Ding 已提交
502 503 504 505 506 507 508 509 510

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | rpc 等待应答最大时长 |
| 单位     | 秒                   |
| 取值范围 | 100-7200             |
| 缺省值   | 600                  |

D
dingbo 已提交
511
### statusInterval
B
Bo Ding 已提交
512 513 514 515 516 517 518 519 520

| 属性     | 说明                        |
| -------- | --------------------------- |
| 适用范围 | 仅服务端适用                |
| 含义     | dnode 向 mnode 报告状态间隔 |
| 单位     | 秒                          |
| 取值范围 | 1-10                        |
| 缺省值   | 1                           |

D
dingbo 已提交
521
### shellActivityTimer
B
Bo Ding 已提交
522 523 524 525 526 527 528 529 530

| 属性     | 说明                              |
| -------- | --------------------------------- |
| 适用范围 | 服务端和客户端均适用              |
| 含义     | shell 客户端向 mnode 发送心跳间隔 |
| 单位     | 秒                                |
| 取值范围 | 1-120                             |
| 缺省值   | 3                                 |

D
dingbo 已提交
531
### tableMetaKeepTimer
B
Bo Ding 已提交
532 533 534 535 536 537 538 539 540

| 属性     | 说明                  |
| -------- | --------------------- |
| 适用范围 | 仅服务端适用          |
| 含义     | 表的元数据 cache 时长 |
| 单位     | 秒                    |
| 取值范围 | 1-8640000             |
| 缺省值   | 7200                  |

D
dingbo 已提交
541
### maxTmerCtrl
B
Bo Ding 已提交
542

D
dingbo 已提交
543 544 545 546 547 548 549
| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | 定时器个数           |
| 单位     | 个                   |
| 取值范围 | 8-2048               |
| 缺省值   | 512                  |
B
Bo Ding 已提交
550

D
dingbo 已提交
551 552 553 554 555 556 557 558 559 560
### offlineThreshold

| 属性     | 说明                                        |
| -------- | ------------------------------------------- |
| 适用范围 | 仅服务端适用                                |
| 含义     | dnode 离线阈值,超过该时间将导致 dnode 离线 |
| 单位     | 秒                                          |
| 取值范围 | 5-7200000                                   |
| 缺省值   | 86400\*10(10 天)                          |

B
Bo Ding 已提交
561

562
## 性能调优
D
dingbo 已提交
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582

### numOfThreadsPerCore

| 属性     | 说明                                |
| -------- | ----------------------------------- |
| 适用范围 | 服务端和客户端均适用                |
| 含义     | 每个 CPU 核生成的队列消费者线程数量 |
| 缺省值   | 1.0                                 |

### ratioOfQueryThreads

| 属性     | 说明                                                                                                                |
| -------- | ------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                        |
| 含义     | 设置查询线程的最大数量                                                                                              |
| 取值范围 | 0:表示只有 1 个查询线程 <br/> 1:表示最大和 CPU 核数相等的查询线程 <br/> 2:表示最大建立 2 倍 CPU 核数的查询线程。 |
| 缺省值   | 1                                                                                                                   |
| 补充说明 | 该值可以为小数,即 0.5 表示最大建立 CPU 核数一半的查询线程。                                                        |

### maxVgroupsPerDb
B
Bo Ding 已提交
583 584 585 586 587 588 589 590

| 属性     | 说明                                 |
| -------- | ------------------------------------ |
| 适用范围 | 仅服务端适用                         |
| 含义     | 每个 DB 中 能够使用的最大 vnode 个数 |
| 取值范围 | 0-8192                               |
| 缺省值   |                                      |

D
dingbo 已提交
591
### maxTablesPerVnode
B
Bo Ding 已提交
592 593 594 595 596 597 598

| 属性     | 说明                              |
| -------- | --------------------------------- |
| 适用范围 | 仅服务端适用                      |
| 含义     | 每个 vnode 中能够创建的最大表个数 |
| 缺省值   | 1000000                           |

599
### minTablesPerVnode
B
Bo Ding 已提交
600

601 602 603 604 605
| 属性     | 说明                              |
| -------- | --------------------------------- |
| 适用范围 | 仅服务端适用                      |
| 含义     | 每个 vnode 中必须创建表的最小数量 |
| 缺省值   | 1000                              |
B
Bo Ding 已提交
606

607
### tableIncStepPerVnode
B
Bo Ding 已提交
608

609 610 611 612 613
| 属性     | 说明                                |
| -------- | ----------------------------------- |
| 适用范围 | 仅服务端适用                        |
| 含义     | 每个 vnode 中超过最小表数,i.e. minTablesPerVnode, 后递增步长 |
| 缺省值   | 1000                                |
B
Bo Ding 已提交
614

615 616 617 618 619 620 621
### maxNumOfOrderedRes

| 属性     | 说明                                   |
| -------- | -------------------------------------- |
| 适用范围 | 服务端和客户端均适用                   |
| 含义     | 支持超级表时间排序允许的最多记录数限制 |
| 缺省值   | 10 万                                  |
B
Bo Ding 已提交
622 623


D
dingbo 已提交
624
### mnodeEqualVnodeNum
B
Bo Ding 已提交
625

D
dingbo 已提交
626 627 628
| 属性     | 说明                               |
| -------- | ---------------------------------- |
| 适用范围 | 仅服务端适用                       |
629
| 含义     | 将一个 mnode 等同于 vnode 消耗的个数 |
D
dingbo 已提交
630
| 缺省值   | 4                                  |
B
Bo Ding 已提交
631

632 633 634 635 636 637 638 639
### numOfCommitThreads

| 属性     | 说明                   |
| -------- | ---------------------- |
| 适用范围 | 仅服务端适用           |
| 含义     | 设置写入线程的最大数量 |
| 缺省值   |                        |

D
dingbo 已提交
640
## 压缩相关
B
Bo Ding 已提交
641

D
dingbo 已提交
642
### comp
B
Bo Ding 已提交
643 644 645 646 647 648 649 650

| 属性     | 说明                                |
| -------- | ----------------------------------- |
| 适用范围 | 仅服务端适用                        |
| 含义     | 文件压缩标志位                      |
| 取值范围 | 0:关闭,1:一阶段压缩,2:两阶段压缩 |
| 缺省值   | 2                                   |

651 652 653 654 655 656 657 658
### tsdbMetaCompactRatio

| 属性     | 说明                                                           |
| -------- | -------------------------------------------------------------- |
| 含义     | tsdb meta 文件中冗余数据超过多少阈值,开启 meta 文件的压缩功能 |
| 取值范围 | 0:不开启,[1-100]:冗余数据比例                               |
| 缺省值   | 0                                                              |

D
dingbo 已提交
659
### compressMsgSize
B
Bo Ding 已提交
660 661 662 663 664 665 666 667 668

| 属性     | 说明                                                                                                                                           |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                                   |
| 含义     | 客户端与服务器之间进行消息通讯过程中,对通讯的消息进行压缩的阈值。如果要压缩消息,建议设置为 64330 字节,即大于 64330 字节的消息体才进行压缩。 |
| 单位     | bytes                                                                                                                                          |
| 取值范围 | `0 `表示对所有的消息均进行压缩 >0: 超过该值的消息才进行压缩 -1: 不压缩                                                                         |
| 缺省值   | -1                                                                                                                                             |

D
dingbo 已提交
669
### compressColData
B
Bo Ding 已提交
670

D
dingbo 已提交
671 672 673 674 675 676 677 678
| 属性     | 说明                                                                                    |
| -------- | --------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                            |
| 含义     | 客户端与服务器之间进行消息通讯过程中,对服务器端查询结果进行列压缩的阈值。              |
| 单位     | bytes                                                                                   |
| 取值范围 | 0: 对所有查询结果均进行压缩 >0: 查询结果中任意列大小超过该值的消息才进行压缩 -1: 不压缩 |
| 缺省值   | -1                                                                                      |
| 补充说明 | 2.3.0.0 版本新增。                                                                      |
B
Bo Ding 已提交
679

D
dingbo 已提交
680
### lossyColumns
B
Bo Ding 已提交
681

D
dingbo 已提交
682 683 684 685 686 687 688
| 属性     | 说明                                                                                                                                                         |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 适用范围 | 服务器端                                                                                                                                                     |
| 含义     | 配置要进行有损压缩的浮点数据类型                                                                                                                             |
| 取值范围 | 空字符串:关闭有损压缩 <br/> float:只对 float 类型进行有损压缩 <br/>double:只对 double 类型进行有损压缩 <br/> float \| double:float double 都进行有损压缩 |
| 缺省值   | 128                                                                                                                                                          |
| 补充说明 | 有损压缩默认为关闭状态,只有配置后才生效                                                                                                                     |
B
Bo Ding 已提交
689

D
dingbo 已提交
690
### fPrecision
B
Bo Ding 已提交
691

D
dingbo 已提交
692 693 694 695 696 697 698
| 属性     | 说明                             |
| -------- | -------------------------------- |
| 适用范围 | 服务器端                         |
| 含义     | 设置 float 类型浮点数压缩精度    |
| 取值范围 | 0.1 ~ 0.00000001                 |
| 缺省值   | 0.00000001                       |
| 补充说明 | 小于此值的浮点数尾数部分将被截取 |
B
Bo Ding 已提交
699

D
dingbo 已提交
700
### dPrecision
B
Bo Ding 已提交
701

D
dingbo 已提交
702 703 704 705 706 707 708
| 属性     | 说明                             |
| -------- | -------------------------------- |
| 适用范围 | 服务器端                         |
| 含义     | 设置 double 类型浮点数压缩精度   |
| 取值范围 | 0.1 ~ 0.0000000000000001         |
| 缺省值   | 0.0000000000000001               |
| 补充说明 | 小于此值的浮点数尾数部分将被截取 |
B
Bo Ding 已提交
709

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
## 流计算相关

### stream

| 属性     | 说明                           |
| -------- | ------------------------------ |
| 适用范围 | 仅服务端适用                   |
| 含义     | 是否启用连续查询(流计算功能) |
| 取值范围 | 0:不允许 <br/> 1:允许        |
| 缺省值   | 1                              |

### minSlidingTime

| 属性     | 说明                                |
| -------- | ----------------------------------- |
| 适用范围 | 仅服务端适用                        |
| 含义     | 最小滑动窗口时长                    |
| 单位     | 毫秒                                |
| 取值范围 | 10-1000000                          |
| 缺省值   | 10                                  |
| 补充说明 | 支持 us 补值后,这个值就是 1us 了。 |

### minIntervalTime

| 属性     | 说明           |
| -------- | -------------- |
| 适用范围 | 仅服务端适用   |
| 含义     | 时间窗口最小值 |
| 单位     | 毫秒           |
| 取值范围 | 1-1000000      |
| 缺省值   | 10             |

### maxStreamCompDelay

| 属性     | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 适用范围 | 仅服务端适用                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| 含义     | 连续查询启动最大延迟                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| 单位     | 毫秒                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| 取值范围 | 10-1000000000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| 缺省值   | 20000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

### maxFirstStreamCompDelay

| 属性     | 说明                       |
| -------- | -------------------------- |
| 适用范围 | 仅服务端适用               |
| 含义     | 第一次连续查询启动最大延迟 |
| 单位     | 毫秒                       |
| 取值范围 | 10-1000000000              |
| 缺省值   | 10000                      |

### retryStreamCompDelay

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 仅服务端适用         |
| 含义     | 连续查询重试等待间隔 |
| 单位     | 毫秒                 |
| 取值范围 | 10-1000000000        |
| 缺省值   | 10                   |

### streamCompDelayRatio

| 属性     | 说明                       |
| -------- | -------------------------- |
| 适用范围 | 仅服务端适用               |
| 含义     | 连续查询的延迟时间计算系数,实际延迟时间为本参数乘以计算时间窗口 |
| 取值范围 | 0.1-0.9                    |
| 缺省值   | 0.1                        |

:::info
为避免多个 stream 同时执行占用太多系统资源,程序中对 stream 的执行时间人为增加了一些随机的延时。<br/>maxFirstStreamCompDelay 是 stream 第一次执行前最少要等待的时间。<br/>streamCompDelayRatio 是延迟时间的计算系数,它乘以查询的 interval 后为延迟时间基准。<br/>maxStreamCompDelay 是延迟时间基准的上限。<br/>实际延迟时间为一个不超过延迟时间基准的随机值。<br/>stream 某次计算失败后需要重试,retryStreamCompDelay 是重试的等待时间基准。<br/>实际重试等待时间为不超过等待时间基准的随机值。

:::

D
dingbo 已提交
786
## HTTP 相关
B
Bo Ding 已提交
787

788 789 790 791 792 793
:::note
HTTP服务在2.4.0.0(不含)以前的版本中由taosd提供,在2.4.0.0以后(含)由taosAdapter提供。
本节的配置参数仅在2.4.0.0(不含)以前的版本中生效。如果您使用的是2.4.0.0(含)及以后的版本请参考[文档](https://www.taosdata.com/cn/documentation/tools/adapter)

:::

D
dingbo 已提交
794
### http
B
Bo Ding 已提交
795 796 797 798 799 800 801 802

| 属性     | 说明                                    |
| -------- | --------------------------------------- |
| 适用范围 | 仅服务端适用                            |
| 含义     | 服务器内部的 http 服务开关。            |
| 取值范围 | 0:关闭 http 服务, 1:激活 http 服务。 |
| 缺省值   | 1                                       |

D
dingbo 已提交
803
### httpEnableRecordSql
B
Bo Ding 已提交
804 805 806 807

| 属性     | 说明                                                                                                                                                    |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                                            |
808
| 含义     | 记录通过 RESTFul 接口,产生的 SQL 调用。 |
B
Bo Ding 已提交
809 810 811
| 缺省值   | 0                                                                                                                                                       |
| 补充说明 | 生成的文件(httpnote.0/httpnote.1),与服务端日志所在目录相同。                                                                                         |

D
dingbo 已提交
812
### httpMaxThreads
B
Bo Ding 已提交
813 814 815 816 817 818 819

| 属性     | 说明                                                                                                                        |
| -------- | --------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                |
| 含义     | RESTFul 接口的线程数。taosAdapter 配置或有不同,请参考相应[文档](https://www.taosdata.com/cn/documentation/tools/adapter)。 |
| 缺省值   | 2                                                                                                                           |

D
dingbo 已提交
820
### restfulRowLimit
B
Bo Ding 已提交
821 822 823 824 825 826 827 828

| 属性     | 说明                                                                                                                                  |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                          |
| 含义     | RESTFul 接口单次返回的记录条数。taosAdapter 配置或有不同,请参考相应[文档](https://www.taosdata.com/cn/documentation/tools/adapter)。 |
| 缺省值   | 10240                                                                                                                                 |
| 补充说明 | 最大 10,000,000                                                                                                                       |

D
dingbo 已提交
829 830 831 832 833 834 835 836 837 838 839 840
### httpDBNameMandatory

| 属性     | 说明                         |
| -------- | ---------------------------- |
| 适用范围 | 仅服务端适用                 |
| 含义     | 是否在 URL 中输入 数据库名称 |
| 取值范围 | 0:不开启,1:开启           |
| 缺省值   | 0                            |
| 补充说明 | 2.3 版本新增。               |

## 日志相关

841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
### logDir

| 属性     | 说明                                               |
| -------- | -------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                               |
| 含义     | 日志文件目录,客户端和服务器的运行日志将写入该目录 |
| 缺省值   | /var/log/taos                                      |

### minimalLogDirGB

| 属性     | 说明                                         |
| -------- | -------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                         |
| 含义     | 当日志文件夹的磁盘大小小于该值时,停止写日志 |
| 单位     | GB                                           |
| 缺省值   | 0.1                                          |


D
dingbo 已提交
859
### numOfLogLines
B
Bo Ding 已提交
860 861 862 863 864 865 866

| 属性     | 说明                         |
| -------- | ---------------------------- |
| 适用范围 | 服务端和客户端均适用         |
| 含义     | 单个日志文件允许的最大行数。 |
| 缺省值   | 10,000,000                   |

D
dingbo 已提交
867
### asyncLog
B
Bo Ding 已提交
868 869 870 871 872 873 874 875

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | 日志写入模式         |
| 取值范围 | 0:同步、1:异步     |
| 缺省值   | 1                    |

D
dingbo 已提交
876
### logKeepDays
B
Bo Ding 已提交
877 878 879 880 881 882 883 884 885

| 属性     | 说明                                                                                |
| -------- | ----------------------------------------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                                                                |
| 含义     | 日志文件的最长保存时间                                                              |
| 单位     | 天                                                                                  |
| 缺省值   | 0                                                                                   |
| 补充说明 | 大于 0 时,日志文件会被重命名为 taosdlog.xxx,其中 xxx 为日志文件最后修改的时间戳。 |

D
dingbo 已提交
886
### debugFlag
B
Bo Ding 已提交
887 888 889 890 891 892 893 894

| 属性     | 说明                                                                                              |
| -------- | ------------------------------------------------------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                                                                              |
| 含义     | 运行日志开关                                                                                      |
| 取值范围 | 131(输出错误和警告日志),135(输出错误、警告和调试日志),143(输出错误、警告、调试和跟踪日志) |
| 缺省值   | 131 或 135(不同模块有不同的默认值)                                                              |

D
dingbo 已提交
895
### mDebugFlag
B
Bo Ding 已提交
896 897 898 899 900 901 902 903

| 属性     | 说明               |
| -------- | ------------------ |
| 适用范围 | 仅服务端适用       |
| 含义     | 管理模块的日志开关 |
| 取值范围 | 同上               |
| 缺省值   | 135                |

D
dingbo 已提交
904
### dDebugFlag
B
Bo Ding 已提交
905 906 907 908 909 910 911 912

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | dnode 模块的日志开关 |
| 取值范围 | 同上                 |
| 缺省值   | 135                  |

D
dingbo 已提交
913
### sDebugFlag
B
Bo Ding 已提交
914 915 916 917 918 919 920 921

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | sync 模块的日志开关  |
| 取值范围 | 同上                 |
| 缺省值   | 135                  |

D
dingbo 已提交
922
### wDebugFlag
B
Bo Ding 已提交
923 924 925 926 927 928 929 930

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | wal 模块的日志开关   |
| 取值范围 | 同上                 |
| 缺省值   | 135                  |

D
dingbo 已提交
931
### sdbDebugFlag
B
Bo Ding 已提交
932 933 934 935 936 937 938 939

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | sdb 模块的日志开关   |
| 取值范围 | 同上                 |
| 缺省值   | 135                  |

D
dingbo 已提交
940
### rpcDebugFlag
B
Bo Ding 已提交
941 942 943 944 945 946 947 948

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | rpc 模块的日志开关   |
| 取值范围 | 同上                 |
| 缺省值   |                      |

D
dingbo 已提交
949
### tmrDebugFlag
B
Bo Ding 已提交
950 951 952 953 954 955 956 957

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | 定时器模块的日志开关 |
| 取值范围 | 同上                 |
| 缺省值   |                      |

D
dingbo 已提交
958
### cDebugFlag
B
Bo Ding 已提交
959 960 961 962 963 964 965 966

| 属性     | 说明                  |
| -------- | --------------------- |
| 适用范围 | 仅客户端适用          |
| 含义     | client 模块的日志开关 |
| 取值范围 | 同上                  |
| 缺省值   |                       |

D
dingbo 已提交
967
### jniDebugFlag
B
Bo Ding 已提交
968 969 970 971 972 973 974 975

| 属性     | 说明               |
| -------- | ------------------ |
| 适用范围 | 仅客户端适用       |
| 含义     | jni 模块的日志开关 |
| 取值范围 | 同上               |
| 缺省值   |                    |

D
dingbo 已提交
976
### odbcDebugFlag
B
Bo Ding 已提交
977 978 979 980 981 982 983 984

| 属性     | 说明                |
| -------- | ------------------- |
| 适用范围 | 仅客户端适用        |
| 含义     | odbc 模块的日志开关 |
| 取值范围 | 同上                |
| 缺省值   |                     |

D
dingbo 已提交
985
### uDebugFlag
B
Bo Ding 已提交
986 987 988 989 990 991 992 993

| 属性     | 说明                   |
| -------- | ---------------------- |
| 适用范围 | 服务端和客户端均适用   |
| 含义     | 共用功能模块的日志开关 |
| 取值范围 | 同上                   |
| 缺省值   |                        |

D
dingbo 已提交
994
### httpDebugFlag
B
Bo Ding 已提交
995 996 997 998 999 1000 1001 1002

| 属性     | 说明                |
| -------- | ------------------- |
| 适用范围 | 仅服务端适用        |
| 含义     | http 模块的日志开关 |
| 取值范围 | 同上                |
| 缺省值   |                     |

D
dingbo 已提交
1003
### mqttDebugFlag
B
Bo Ding 已提交
1004 1005 1006 1007 1008 1009 1010 1011

| 属性     | 说明                |
| -------- | ------------------- |
| 适用范围 | 仅服务端适用        |
| 含义     | mqtt 模块的日志开关 |
| 取值范围 | 同上                |
| 缺省值   |                     |

D
dingbo 已提交
1012
### monitorDebugFlag
B
Bo Ding 已提交
1013 1014 1015 1016 1017 1018 1019 1020

| 属性     | 说明               |
| -------- | ------------------ |
| 适用范围 | 仅服务端适用       |
| 含义     | 监控模块的日志开关 |
| 取值范围 | 同上               |
| 缺省值   |                    |

D
dingbo 已提交
1021
### qDebugFlag
B
Bo Ding 已提交
1022 1023 1024 1025 1026 1027 1028 1029

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | 查询模块的日志开关   |
| 取值范围 | 同上                 |
| 缺省值   |                      |

D
dingbo 已提交
1030
### vDebugFlag
B
Bo Ding 已提交
1031 1032 1033 1034 1035 1036 1037 1038

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
| 含义     | vnode 模块的日志开关 |
| 取值范围 | 同上                 |
| 缺省值   |                      |

D
dingbo 已提交
1039
### tsdbDebugFlag
B
Bo Ding 已提交
1040 1041 1042 1043 1044 1045 1046 1047

| 属性     | 说明                |
| -------- | ------------------- |
| 适用范围 | 仅服务端适用        |
| 含义     | TSDB 模块的日志开关 |
| 取值范围 | 同上                |
| 缺省值   |                     |

D
dingbo 已提交
1048
### cqDebugFlag
B
Bo Ding 已提交
1049 1050 1051 1052 1053 1054 1055 1056

| 属性     | 说明                   |
| -------- | ---------------------- |
| 适用范围 | 服务端和客户端均适用   |
| 含义     | 连续查询模块的日志开关 |
| 取值范围 | 同上                   |
| 缺省值   |                        |

D
dingbo 已提交
1057
## 仅客户端适用
B
Bo Ding 已提交
1058

D
dingbo 已提交
1059
### maxSQLLength
B
Bo Ding 已提交
1060

D
dingbo 已提交
1061 1062 1063 1064 1065 1066 1067
| 属性     | 说明                        |
| -------- | --------------------------- |
| 适用范围 | 仅客户端适用                |
| 含义     | 单条 SQL 语句允许的最长限制 |
| 单位     | bytes                       |
| 取值范围 | 65480-1048576               |
| 缺省值   | 1048576                     |
B
Bo Ding 已提交
1068

D
dingbo 已提交
1069
### tscEnableRecordSql
B
Bo Ding 已提交
1070

D
dingbo 已提交
1071 1072 1073 1074 1075 1076
| 属性     | 说明                                                                                |
| -------- | ----------------------------------------------------------------------------------- |
| 含义     | 是否记录客户端 sql 语句到文件                                                       |
| 取值范围 | 0:否,1:是                                                                        |
| 缺省值   | 0                                                                                   |
| 补充说明 | 生成的文件(tscnote-xxxx.0/tscnote-xxx.1,xxxx 是 pid),与客户端日志所在目录相同。 |
B
Bo Ding 已提交
1077

D
dingbo 已提交
1078
### maxBinaryDisplayWidth
B
Bo Ding 已提交
1079

D
dingbo 已提交
1080 1081 1082 1083 1084
| 属性     | 说明                                                                                                                                                                                                                                                                          |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 含义     | Taos shell 中 binary 和 nchar 字段的显示宽度上限,超过此限制的部分将被隐藏                                                                                                                                                                                                    |
| 取值范围 | 5 -                                                                                                                                                                                                                                                                           |
| 缺省值   | 30                                                                                                                                                                                                                                                                            |
1085 1086 1087 1088 1089

:::info
实际上限按以下规则计算:如果字段值的长度大于 maxBinaryDisplayWidth,则显示上限为 **字段名长度****maxBinaryDisplayWidth** 的较大者。<br/>否则,上限为 **字段名长度****字段值长度** 的较大者。<br/>可在 shell 中通过命令 set max_binary_display_width nn 动态修改此选项

:::
B
Bo Ding 已提交
1090

D
dingbo 已提交
1091
### maxWildCardsLength
B
Bo Ding 已提交
1092 1093 1094 1095 1096 1097 1098 1099 1100

| 属性     | 说明                                       |
| -------- | ------------------------------------------ |
| 含义     | 设定 LIKE 算子的通配符字符串允许的最大长度 |
| 单位     | bytes                                      |
| 取值范围 | 0-16384                                    |
| 缺省值   | 100                                        |
| 补充说明 | 2.1.6.1 版本新增。                         |

D
dingbo 已提交
1101
### clientMerge
B
Bo Ding 已提交
1102 1103 1104 1105 1106 1107 1108 1109

| 属性     | 说明                         |
| -------- | ---------------------------- |
| 含义     | 是否允许客户端对写入数据去重 |
| 取值范围 | 0:不开启,1:开启           |
| 缺省值   | 0                            |
| 补充说明 | 2.3 版本新增。               |

D
dingbo 已提交
1110
### maxRegexStringLen
B
Bo Ding 已提交
1111 1112 1113 1114 1115 1116 1117 1118

| 属性     | 说明                       |
| -------- | -------------------------- |
| 含义     | 正则表达式最大允许长度     |
| 取值范围 | 默认值 128,最大长度 16384 |
| 缺省值   | 128                        |
| 补充说明 | 2.3 版本新增。             |

D
dingbo 已提交
1119
## 其他
B
Bo Ding 已提交
1120

1121
### enableCoreFile
D
dingbo 已提交
1122

1123 1124 1125 1126 1127 1128 1129
| 属性     | 说明                                                                                                                                       |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| 适用范围 | 服务端和客户端均适用                                                                                                                       |
| 含义     | 是否开启服务 crash 时生成 core 文件                                                                                                        |
| 取值范围 | 0:否,1:是                                                                                                                               |
| 缺省值   | 1                                                                                                                                          |
| 补充说明 | 不同的启动方式,生成 core 文件的目录如下:1、systemctl start taosd 启动:生成的 core 在根目录下 <br/> 2、手动启动,就在 taosd 执行目录下。 |