index.md 52.8 KB
Newer Older
1 2
---
title: 配置参数
3
description: "TDengine 客户端和服务配置列表"
4 5 6 7
---

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

8
TDengine 系统后台服务由 taosd 提供,可以在配置文件 taos.cfg 里修改配置参数,以满足不同场景的需求。在 Linux 系统上,配置文件的缺省位置在 `/etc/taos` 目录,在 Windows 系统上缺省位置在 `C:\TDengine` 。可以通过 taosd 命令行执行参数 -c 指定配置文件所在目录。比如,在 Linux 系统上可以指定配置文件位于 `/home/user` 这个目录:
9 10 11 12 13 14 15 16 17 18 19 20 21

```
taosd -c /home/user
```

另外可以使用 `-C` 显示当前服务器配置参数:

```
taosd -C
```

## 为客户端指定配置文件

B
Bo Ding 已提交
22
TDengine 系统的前台交互客户端应用程序为 taos,以及应用驱动,它可以与 taosd 共享同一个配置文件 taos.cfg,也可以使用单独指定配置文件。运行 taos 时,使用参数-c 指定配置文件目录,如:
23 24

```
B
Bo Ding 已提交
25 26 27 28
taos -c /home/cfg
```

表示使用/home/cfg/目录下的 taos.cfg 配置文件中的参数,缺省目录是/etc/taos。 另外可以使用 `-C` 显示当前服务器配置参数:
29 30

```bash
B
Bo Ding 已提交
31
taos -C
32 33
```

B
Bo Ding 已提交
34 35
更多 taos 的使用方法请见帮助信息 `taos --help`

36
## 配置参数详细列表
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

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

:::

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

:::

## 连接相关

### firstEp

52 53 54
| 属性     | 说明                                                           |
| -------- | -------------------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                                           |
55
| 含义     | taosd 或者 taos 启动时,主动连接的集群中首个 dnode 的 endpoint |
56
| 缺省值   | localhost:6030                                                 |
57 58 59

### secondEp

60 61 62
| 属性     | 说明                                                                                  |
| -------- | ------------------------------------------------------------------------------------- |
| 适用范围 | 服务端和客户端均适用                                                                  |
63
| 含义     | taosd 或者 taos 启动时,如果 firstEp 连接不上,尝试连接集群中第二个 dnode 的 endpoint |
64
| 缺省值   | 无                                                                                    |
65 66 67 68 69 70 71 72 73 74 75 76

### fqdn

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

### serverPort

77 78 79 80 81
| 属性     | 说明                           |
| -------- | ------------------------------ |
| 适用范围 | 仅服务端适用                   |
| 含义     | taosd 启动后,对外服务的端口号 |
| 缺省值   | 6030                           |
82 83

:::note
S
Shengliang Guan 已提交
84
确保集群中所有主机在端口 6030 上的 TCP 协议能够互通。(详细的端口情况请参见下表)
85
:::
dengyihao's avatar
dengyihao 已提交
86 87 88 89 90 91 92 93
| 协议 | 默认端口 | 用途说明                                         | 修改方法                                                                                           |
| :--- | :------- | :----------------------------------------------- | :------------------------------------------------------------------------------------------------- |
| TCP  | 6030     | 客户端与服务端之间通讯,多节点集群的节点间通讯。 | 由配置文件设置 serverPort 决定。                                                                   |
| TCP  | 6041     | 客户端与服务端之间的 RESTful 通讯。              | 随 serverPort 端口变化。注意 taosAdapter 配置或有不同,请参考相应[文档](/reference/taosadapter/)。 |
| TCP  | 6043     | taosKeeper 监控服务端口。                        | 随 taosKeeper 启动参数设置变化。                                                                   |
| TCP  | 6044     | 支持 StatsD 的数据接入端口。                     | 随 taosAdapter 启动参数设置变化                                                                    |
| UDP  | 6045     | 支持 collectd 数据接入端口。                     | 随 taosAdapter 启动参数设置变化                                                                    |
| TCP  | 6060     | 企业版内 Monitor 服务的网络端口。                |                                                                                                    |
94 95 96 97

### maxShellConns

| 属性     | 说明                    |
dengyihao's avatar
dengyihao 已提交
98
| -------- | ----------------------- |
99
| 适用范围 | 仅服务端适用            |
dengyihao's avatar
dengyihao 已提交
100
| 含义     | 一个 dnode 容许的连接数 |
101
| 取值范围 | 10-50000000             |
dengyihao's avatar
dengyihao 已提交
102
| 缺省值   | 5000                    |
dengyihao's avatar
dengyihao 已提交
103

104
### numOfRpcSessions
dengyihao's avatar
dengyihao 已提交
105 106 107 108 109 110

| 属性     | 说明                         |
| -------- | ---------------------------- |
| 适用范围 | 客户端和服务端都适用         |
| 含义     | 一个客户端能创建的最大连接数 |
| 取值范围 | 100-100000                   |
dengyihao's avatar
dengyihao 已提交
111
| 缺省值   | 30000                        |
dengyihao's avatar
dengyihao 已提交
112 113 114 115 116 117 118 119 120 121

### timeToGetAvailableConn

| 属性     | 说明                       |
| -------- | -------------------------- |
| 适用范围 | 客户端和服务端都适用       |
| 含义     | 获得可用连接的最长等待时间 |
| 取值范围 | 10-50000000(单位为毫秒)    |
| 缺省值   | 500000                     |

122 123
## 监控相关

124 125 126
:::note
请注意,完整的监控功能需要安装并运行 `taoskeeper` 服务。taoskeeper 负责接收监控指标数据并创建 `log` 库。

B
Bo Ding 已提交
127 128
:::

129 130
### monitor

131 132 133
| 属性     | 说明                                                                                                                                                                                               |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                                                                                       |
134
| 含义     | 服务器内部的系统监控开关。监控主要负责收集物理节点的负载状况,包括 CPU、内存、硬盘、网络带宽的监控记录,监控信息将通过 HTTP 协议发送给由 `monitorFqdn``monitorProt` 指定的 taosKeeper 监控服务 |
135
| 取值范围 | 0:关闭监控服务, 1:激活监控服务。                                                                                                                                                                |
136
| 缺省值   | 0                                                                                                                                                                                                  |
137

S
Shengliang Guan 已提交
138 139
### monitorFqdn

140 141 142
| 属性     | 说明                       |
| -------- | -------------------------- |
| 适用范围 | 仅服务端适用               |
143
| 含义     | taosKeeper 监控服务的 FQDN |
144
| 缺省值   | 无                         |
S
Shengliang Guan 已提交
145 146 147

### monitorPort

148 149 150
| 属性     | 说明                        |
| -------- | --------------------------- |
| 适用范围 | 仅服务端适用                |
151
| 含义     | taosKeeper 监控服务的端口号 |
152
| 缺省值   | 6043                        |
S
Shengliang Guan 已提交
153

154 155 156 157 158 159 160
### monitorInterval

| 属性     | 说明                                         |
| -------- | -------------------------------------------- |
| 适用范围 | 仅服务端适用                                 |
| 含义     | 监控数据库记录系统参数(CPU/内存)的时间间隔 |
| 单位     | 秒                                           |
161
| 取值范围 | 1-200000                                     |
162 163
| 缺省值   | 30                                           |

W
wade zhang 已提交
164 165
### telemetryReporting

dengyihao's avatar
dengyihao 已提交
166 167
| 属性     | 说明                     |
| -------- | ------------------------ |
G
Ganlin Zhao 已提交
168
| 适用范围 | 客户端和服务端都适用     |
dengyihao's avatar
dengyihao 已提交
169 170 171
| 含义     | 是否上传 telemetry       |
| 取值范围 | 0,1   0: 不上传;1:上传 |
| 缺省值   | 1                        |
W
wade zhang 已提交
172 173 174

### crashReporting

dengyihao's avatar
dengyihao 已提交
175 176
| 属性     | 说明                     |
| -------- | ------------------------ |
G
Ganlin Zhao 已提交
177
| 适用范围 | 客户端和服务端都适用     |
dengyihao's avatar
dengyihao 已提交
178 179 180
| 含义     | 是否上传 crash 信息      |
| 取值范围 | 0,1   0: 不上传;1:上传 |
| 缺省值   | 1                        |
W
wade zhang 已提交
181

182 183
## 查询相关

184 185
### queryPolicy

dengyihao's avatar
dengyihao 已提交
186 187 188 189 190 191
| 属性     | 说明                                                                                                                                                   |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 适用范围 | 仅客户端适用                                                                                                                                           |
| 含义     | 查询语句的执行策略                                                                                                                                     |
| 单位     | 无                                                                                                                                                     |
| 缺省值   | 1                                                                                                                                                      |
W
wade zhang 已提交
192
| 补充说明 | 1: 只使用 vnode,不使用 qnode; 2: 没有扫描算子的子任务在 qnode 执行,带扫描算子的子任务在 vnode 执行; 3: vnode 只运行扫描算子,其余算子均在 qnode 执行 |
193 194 195

### querySmaOptimize

dengyihao's avatar
dengyihao 已提交
196 197 198 199 200 201 202
| 属性     | 说明                                                                                                             |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅客户端适用                                                                                                     |
| 含义     | sma index 的优化策略                                                                                             |
| 单位     | 无                                                                                                               |
| 缺省值   | 0                                                                                                                |
| 补充说明 | 0: 表示不使用 sma index,永远从原始数据进行查询; 1: 表示使用 sma index,对符合的语句,直接从预计算的结果进行查询 |
203 204 205 206

### maxNumOfDistinctRes

| 属性     | 说明                             |
207
| -------- | -------------------------------- |
208 209 210 211 212
| 适用范围 | 仅服务端适用                     |
| 含义     | 允许返回的 distinct 结果最大行数 |
| 取值范围 | 默认值为 10 万,最大值 1 亿      |
| 缺省值   | 10 万                            |

213 214
### keepColumnName

dengyihao's avatar
dengyihao 已提交
215 216 217
| 属性     | 说明                                                        |
| -------- | ----------------------------------------------------------- |
| 适用范围 | 仅客户端适用                                                |
218
| 含义     | Last、First、LastRow 函数查询时,返回的列名是否包含函数名。 |
dengyihao's avatar
dengyihao 已提交
219 220
| 取值范围 | 0 表示包含函数名,1 表示不包含函数名。                      |
| 缺省值   | 0                                                           |
221

222
### countAlwaysReturnValue
G
gccgdb1234 已提交
223

dengyihao's avatar
dengyihao 已提交
224 225 226 227 228 229
| 属性     | 说明                                                                                                                                           |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                                   |
| 含义     | count/hyperloglog函数在输入数据为空或者NULL的情况下是否返回值                                                                                  |
| 取值范围 | 0:返回空行,1:返回 0                                                                                                                         |
| 缺省值   | 1                                                                                                                                              |
D
dapan1121 已提交
230
| 补充说明 | 该参数设置为 1 时,如果查询中含有 GROUP BY,PARTITION BY 以及 INTERVAL 子句且相应的组或窗口内数据为空或者NULL, 对应的组或窗口将不返回查询结果 |
G
gccgdb1234 已提交
231

232 233 234 235 236 237 238 239 240 241 242 243 244
## 区域相关

### timezone

| 属性     | 说明                           |
| -------- | ------------------------------ |
| 适用范围 | 服务端和客户端均适用           |
| 含义     | 时区                           |
| 缺省值   | 从系统中动态获取当前的时区设置 |

:::info
为应对多时区的数据写入和查询问题,TDengine 采用 Unix 时间戳(Unix Timestamp)来记录和存储时间戳。Unix 时间戳的特点决定了任一时刻不论在任何时区,产生的时间戳均一致。需要注意的是,Unix 时间戳是在客户端完成转换和记录。为了确保客户端其他形式的时间转换为正确的 Unix 时间戳,需要设置正确的时区。

wafwerar's avatar
wafwerar 已提交
245
在 Linux/macOS 中,客户端会自动读取系统设置的时区信息。用户也可以采用多种方式在配置文件设置时区。例如:
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 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

```
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 时间戳不受系统所在时区的影响。

:::

### locale

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

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

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

wafwerar's avatar
wafwerar 已提交
290
在 Linux/macOS 中 locale 的命名规则为: <语言>\_<地区>.<字符集编码> 如:zh_CN.UTF-8,zh 代表中文,CN 代表大陆地区,UTF-8 表示字符集。字符集编码为客户端正确解析本地字符串提供编码转换的说明。Linux/macOS 可以通过设置 locale 来确定系统的字符编码,由于 Windows 使用的 locale 中不是 POSIX 标准的 locale 格式,因此在 Windows 下需要采用另一个配置参数 charset 来指定字符编码。在 Linux/macOS 中也可以使用 charset 来指定字符编码。
291 292 293 294 295 296 297 298 299 300 301 302

:::

### charset

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

:::info
wafwerar's avatar
wafwerar 已提交
303
如果配置文件中不设置 charset,在 Linux/macOS 中,taos 在启动时候,自动读取系统当前的 locale 信息,并从 locale 信息中解析提取 charset 编码格式。如果自动读取 locale 信息失败,则尝试读取 charset 配置,如果读取 charset 配置也失败,则中断启动过程。
304

wafwerar's avatar
wafwerar 已提交
305
在 Linux/macOS 中,locale 信息包含了字符编码信息,因此正确设置了 Linux/macOS 的 locale 以后可以不用再单独设置 charset。例如:
306 307 308 309 310 311 312 313 314 315 316 317 318

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

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

```
charset CP936
```

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

wafwerar's avatar
wafwerar 已提交
319
在 Linux/macOS 中,如果用户同时设置了 locale 和字符集编码 charset,并且 locale 和 charset 的不一致,后设置的值将覆盖前面设置的值。
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340

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

则 charset 的有效值是 GBK。

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

charset 的有效值是 UTF-8。

:::

## 存储相关

### dataDir

dengyihao's avatar
dengyihao 已提交
341 342 343 344 345
| 属性     | 说明                                                                                                                                                                                                          |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 适用范围 | 仅服务端适用                                                                                                                                                                                                  |
| 含义     | 数据文件目录,所有的数据文件都将写入该目录                                                                                                                                                                    |
| 缺省值   | /var/lib/taos                                                                                                                                                                                                 |
C
Cary Xu 已提交
346
| 补充说明 | [多级存储](https://docs.taosdata.com/tdinternal/arch/#%E5%A4%9A%E7%BA%A7%E5%AD%98%E5%82%A8) 功能需要与 [KEEP](https://docs.taosdata.com/taos-sql/database/#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E) 参数配合使用 |
347

G
gccgdb1234 已提交
348 349
### tempDir

dengyihao's avatar
dengyihao 已提交
350 351 352
| 属性     | 说明                                             |
| -------- | ------------------------------------------------ |
| 适用范围 | 仅服务端适用                                     |
G
gccgdb1234 已提交
353
| 含义     | 该参数指定所有系统运行过程中的临时文件生成的目录 |
dengyihao's avatar
dengyihao 已提交
354
| 缺省值   | /tmp                                             |
G
gccgdb1234 已提交
355

356 357 358 359 360
### minimalTmpDirGB

| 属性     | 说明                                             |
| -------- | ------------------------------------------------ |
| 适用范围 | 服务端和客户端均适用                             |
G
gccgdb1234 已提交
361
| 含义     | tempDir 所指定的临时文件目录所需要保留的最小空间 |
362 363 364 365 366
| 单位     | GB                                               |
| 缺省值   | 1.0                                              |

### minimalDataDirGB

dengyihao's avatar
dengyihao 已提交
367 368 369
| 属性     | 说明                                           |
| -------- | ---------------------------------------------- |
| 适用范围 | 仅服务端适用                                   |
G
gccgdb1234 已提交
370
| 含义     | dataDir 指定的时序数据存储目录所需要保留的最小 |
dengyihao's avatar
dengyihao 已提交
371 372
| 单位     | GB                                             |
| 缺省值   | 2.0                                            |
373

374 375
### metaCacheMaxSize

dengyihao's avatar
dengyihao 已提交
376 377 378 379 380 381
| 属性     | 说明                                 |
| -------- | ------------------------------------ |
| 适用范围 | 仅客户端适用                         |
| 含义     | 指定单个客户端元数据缓存大小的最大值 |
| 单位     | MB                                   |
| 缺省值   | -1 (无限制)                          |
382

383 384
## 集群相关

S
Shengliang Guan 已提交
385
### supportVnodes
386

387 388 389 390 391
| 属性     | 说明                        |
| -------- | --------------------------- |
| 适用范围 | 仅服务端适用                |
| 含义     | dnode 支持的最大 vnode 数目 |
| 取值范围 | 0-4096                      |
392
| 缺省值   | CPU 核数的 2 倍             |
393 394 395 396 397 398 399 400 401

## 性能调优

### numOfCommitThreads

| 属性     | 说明                   |
| -------- | ---------------------- |
| 适用范围 | 仅服务端适用           |
| 含义     | 设置写入线程的最大数量 |
402
| 取值范围 | 0-1024                 |
403 404 405 406 407 408 409 410 411 412 413 414 415 416
| 缺省值   |                        |

## 日志相关

### logDir

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

### minimalLogDirGB

dengyihao's avatar
dengyihao 已提交
417 418 419
| 属性     | 说明                                                   |
| -------- | ------------------------------------------------------ |
| 适用范围 | 服务端和客户端均适用                                   |
C
cadem 已提交
420
| 含义     | 当日志文件夹所在磁盘可用空间大小小于该值时,停止写日志 |
dengyihao's avatar
dengyihao 已提交
421 422
| 单位     | GB                                                     |
| 缺省值   | 1.0                                                    |
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450

### numOfLogLines

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

### asyncLog

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

### logKeepDays

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

D
dapan1121 已提交
451 452 453 454 455 456 457 458 459 460 461 462
### slowLogThreshold

| 属性     | 说明                                                          |
| -------- | ------------------------------------------------------------- |
| 适用范围 | 仅客户端适用                                                  |
| 含义     | 指定慢查询门限值,大于等于门限值认为是慢查询                  |
| 单位     | 秒                                                            |
| 缺省值   | 3                                                             |
| 补充说明 | 每个客户端中所有慢查询会被记录在日志目录下的taosSlowLog文件中 |

### slowLogScope

dengyihao's avatar
dengyihao 已提交
463 464 465 466 467 468 469
| 属性     | 说明                                                       |
| -------- | ---------------------------------------------------------- |
| 适用范围 | 仅客户端适用                                               |
| 含义     | 指定启动记录哪些类型的慢查询                               |
| 可选值   | ALL, QUERY, INSERT, OTHERS, NONE                           |
| 缺省值   | ALL                                                        |
| 补充说明 | 默认记录所有类型的慢查询,可通过配置只记录某一类型的慢查询 |
D
dapan1121 已提交
470

471 472 473 474 475 476 477 478 479
### debugFlag

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

S
Shengliang Guan 已提交
480
### tmrDebugFlag
481 482 483 484

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
S
Shengliang Guan 已提交
485
| 含义     | 定时器模块的日志开关 |
486
| 取值范围 | 同上                 |
S
Shengliang Guan 已提交
487
| 缺省值   |                      |
488

S
Shengliang Guan 已提交
489
### uDebugFlag
490

S
Shengliang Guan 已提交
491 492 493 494 495 496
| 属性     | 说明                   |
| -------- | ---------------------- |
| 适用范围 | 服务端和客户端均适用   |
| 含义     | 共用功能模块的日志开关 |
| 取值范围 | 同上                   |
| 缺省值   |                        |
497 498 499 500 501 502 503 504 505 506

### rpcDebugFlag

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

S
Shengliang Guan 已提交
507 508 509 510 511 512 513 514 515 516
### jniDebugFlag

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

### qDebugFlag
517 518 519 520

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
521
| 含义     | query 模块的日志开关 |
522 523 524 525 526 527 528 529 530 531 532 533
| 取值范围 | 同上                 |
| 缺省值   |                      |

### cDebugFlag

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

S
Shengliang Guan 已提交
534
### dDebugFlag
535

S
Shengliang Guan 已提交
536 537
| 属性     | 说明                 |
| -------- | -------------------- |
538
| 适用范围 | 仅服务端适用         |
S
Shengliang Guan 已提交
539 540 541
| 含义     | dnode 模块的日志开关 |
| 取值范围 | 同上                 |
| 缺省值   | 135                  |
542

S
Shengliang Guan 已提交
543
### vDebugFlag
544

S
Shengliang Guan 已提交
545 546
| 属性     | 说明                 |
| -------- | -------------------- |
547
| 适用范围 | 仅服务端适用         |
S
Shengliang Guan 已提交
548 549 550
| 含义     | vnode 模块的日志开关 |
| 取值范围 | 同上                 |
| 缺省值   |                      |
551

S
Shengliang Guan 已提交
552
### mDebugFlag
553

554 555 556 557 558 559 560 561 562
| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 仅服务端适用         |
| 含义     | mnode 模块的日志开关 |
| 取值范围 | 同上                 |
| 缺省值   | 135                  |

### wDebugFlag

563 564 565
| 属性     | 说明               |
| -------- | ------------------ |
| 适用范围 | 仅服务端适用       |
566
| 含义     | wal 模块的日志开关 |
567
| 取值范围 | 同上               |
S
Shengliang Guan 已提交
568
| 缺省值   | 135                |
569

S
Shengliang Guan 已提交
570
### sDebugFlag
571 572 573 574

| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 服务端和客户端均适用 |
S
Shengliang Guan 已提交
575
| 含义     | sync 模块的日志开关  |
576
| 取值范围 | 同上                 |
S
Shengliang Guan 已提交
577
| 缺省值   | 135                  |
578 579 580 581 582 583

### tsdbDebugFlag

| 属性     | 说明                |
| -------- | ------------------- |
| 适用范围 | 仅服务端适用        |
S
Shengliang Guan 已提交
584
| 含义     | tsdb 模块的日志开关 |
585 586 587
| 取值范围 | 同上                |
| 缺省值   |                     |

S
Shengliang Guan 已提交
588
### tqDebugFlag
589

590 591 592
| 属性     | 说明              |
| -------- | ----------------- |
| 适用范围 | 仅服务端适用      |
S
Shengliang Guan 已提交
593
| 含义     | tq 模块的日志开关 |
594 595
| 取值范围 | 同上              |
| 缺省值   |                   |
596

S
Shengliang Guan 已提交
597
### fsDebugFlag
598

599 600 601
| 属性     | 说明              |
| -------- | ----------------- |
| 适用范围 | 仅服务端适用      |
S
Shengliang Guan 已提交
602
| 含义     | fs 模块的日志开关 |
603 604
| 取值范围 | 同上              |
| 缺省值   |                   |
605

S
Shengliang Guan 已提交
606
### udfDebugFlag
607

608 609 610
| 属性     | 说明               |
| -------- | ------------------ |
| 适用范围 | 仅服务端适用       |
S
Shengliang Guan 已提交
611
| 含义     | UDF 模块的日志开关 |
612 613
| 取值范围 | 同上               |
| 缺省值   |                    |
614

S
Shengliang Guan 已提交
615
### smaDebugFlag
616

617 618 619
| 属性     | 说明               |
| -------- | ------------------ |
| 适用范围 | 仅服务端适用       |
S
Shengliang Guan 已提交
620
| 含义     | sma 模块的日志开关 |
621 622
| 取值范围 | 同上               |
| 缺省值   |                    |
623

S
Shengliang Guan 已提交
624
### idxDebugFlag
625

626 627 628
| 属性     | 说明                 |
| -------- | -------------------- |
| 适用范围 | 仅服务端适用         |
S
Shengliang Guan 已提交
629
| 含义     | index 模块的日志开关 |
630 631
| 取值范围 | 同上                 |
| 缺省值   |                      |
632

S
Shengliang Guan 已提交
633
### tdbDebugFlag
634

635 636 637
| 属性     | 说明               |
| -------- | ------------------ |
| 适用范围 | 仅服务端适用       |
S
Shengliang Guan 已提交
638
| 含义     | tdb 模块的日志开关 |
639 640 641 642 643 644 645
| 取值范围 | 同上               |
| 缺省值   |                    |

## Schemaless 相关

### smlChildTableName

dengyihao's avatar
dengyihao 已提交
646 647 648 649 650 651
| 属性     | 说明                            |
| -------- | ------------------------------- |
| 适用范围 | 仅客户端适用                    |
| 含义     | schemaless 自定义的子表名的 key |
| 类型     | 字符串                          |
| 缺省值   | 无                              |
652 653 654 655 656 657 658 659

### smlTagName

| 属性     | 说明                                 |
| -------- | ------------------------------------ |
| 适用范围 | 仅客户端适用                         |
| 含义     | schemaless tag 为空时默认的 tag 名字 |
| 类型     | 字符串                               |
660
| 缺省值   | \_tag_null                           |
661 662 663

### smlDataFormat

dengyihao's avatar
dengyihao 已提交
664 665 666
| 属性     | 说明                                                     |
| -------- | -------------------------------------------------------- |
| 适用范围 | 仅客户端适用                                             |
wmmhello's avatar
wmmhello 已提交
667
| 含义     | schemaless 列数据是否顺序一致,从3.0.3.0开始,该配置废弃 |
dengyihao's avatar
dengyihao 已提交
668
| 值域     | 0:不一致;1: 一致                                       |
dengyihao's avatar
dengyihao 已提交
669
| 缺省值   | 0                                                        |
wmmhello's avatar
wmmhello 已提交
670 671 672

### smlTsDefaultName

dengyihao's avatar
dengyihao 已提交
673 674 675
| 属性     | 说明                                         |
| -------- | -------------------------------------------- |
| 适用范围 | 仅客户端适用                                 |
wmmhello's avatar
wmmhello 已提交
676 677
| 含义     | schemaless自动建表的时间列名字通过该配置设置 |
| 类型     | 字符串                                       |
dengyihao's avatar
dengyihao 已提交
678
| 缺省值   | _ts                                          |
679 680 681 682 683 684 685 686 687 688 689 690

## 其他

### enableCoreFile

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

A
Alex Duan 已提交
692 693
### enableScience

dengyihao's avatar
dengyihao 已提交
694 695 696 697 698 699
| 属性     | 说明                         |
| -------- | ---------------------------- |
| 适用范围 | 仅客户端 TAOS-CLI 适用       |
| 含义     | 是否开启科学计数法显示浮点数 |
| 取值范围 | 0:否,1:是                 |
| 缺省值   | 0                            |
A
Alex Duan 已提交
700

701 702 703 704 705 706 707 708
### udf

| 属性     | 说明               |
| -------- | ------------------ |
| 适用范围 | 仅服务端适用       |
| 含义     | 是否启动 udf 服务  |
| 取值范围 | 0: 不启动;1:启动 |
| 缺省值   | 1                  |
S
Shengliang Guan 已提交
709

710 711
### ttlChangeOnWrite

dengyihao's avatar
dengyihao 已提交
712 713 714 715 716 717
| 属性     | 说明                                 |
| -------- | ------------------------------------ |
| 适用范围 | 仅服务端适用                         |
| 含义     | ttl 到期时间是否伴随表的修改操作改变 |
| 取值范围 | 0: 不改变;1:改变                   |
| 缺省值   | 0                                    |
718

719 720
### keepTimeOffset

dengyihao's avatar
dengyihao 已提交
721 722 723 724 725 726 727
| 属性     | 说明           |
| -------- | -------------- |
| 适用范围 | 仅服务端适用   |
| 含义     | 迁移操作的延时 |
| 单位     | 小时           |
| 取值范围 | 0-23           |
| 缺省值   | 0              |
728

wmmhello's avatar
wmmhello 已提交
729 730
### tmqMaxTopicNum

dengyihao's avatar
dengyihao 已提交
731 732 733 734 735 736
| 属性     | 说明                        |
| -------- | --------------------------- |
| 适用范围 | 仅服务端适用                |
| 含义     | 订阅最多可建立的 topic 数量 |
| 取值范围 | 1-10000                     |
| 缺省值   | 20                          |
wmmhello's avatar
wmmhello 已提交
737

G
gccgdb1234 已提交
738 739 740 741
## 压缩参数

### compressMsgSize

dengyihao's avatar
dengyihao 已提交
742 743 744 745 746 747
| 属性     | 说明                                                                            |
| -------- | ------------------------------------------------------------------------------- |
| 适用于   | 服务端和客户端均适用                                                            |
| 含义     | 是否对 RPC 消息进行压缩                                                         |
| 取值范围 | -1: 所有消息都不压缩; 0: 所有消息都压缩; N (N>0): 只有大于 N 个字节的消息才压缩 |
| 缺省值   | -1                                                                              |
G
gccgdb1234 已提交
748

749
## 3.0 中有效的配置参数列表
750

dengyihao's avatar
dengyihao 已提交
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 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
| #   |        **参数**        | **适用于 2.X ** | **适用于 3.0 **                 | 3.0 版本的当前行为 |
| --- | :--------------------: | --------------- | ------------------------------- | ------------------ |
| 1   |        firstEp         | 是              | 是                              |                    |
| 2   |        secondEp        | 是              | 是                              |                    |
| 3   |          fqdn          | 是              | 是                              |                    |
| 4   |       serverPort       | 是              | 是                              |                    |
| 5   |     maxShellConns      | 是              | 是                              |                    |
| 6   |        monitor         | 是              | 是                              |                    |
| 7   |      monitorFqdn       | 否              | 是                              |                    |
| 8   |      monitorPort       | 否              | 是                              |                    |
| 9   |    monitorInterval     | 是              | 是                              |                    |
| 10  |      queryPolicy       | 否              | 是                              |                    |
| 11  |    querySmaOptimize    | 否              | 是                              |                    |
| 12  |  maxNumOfDistinctRes   | 是              | 是                              |                    |
| 15  | countAlwaysReturnValue | 是              | 是                              |                    |
| 16  |        dataDir         | 是              | 是                              |                    |
| 17  |    minimalDataDirGB    | 是              | 是                              |                    |
| 18  |     supportVnodes      | 否              | 是                              |                    |
| 19  |        tempDir         | 是              | 是                              |                    |
| 20  |    minimalTmpDirGB     | 是              | 是                              |                    |
| 21  |   smlChildTableName    | 是              | 是                              |                    |
| 22  |       smlTagName       | 是              | 是                              |                    |
| 23  |     smlDataFormat      | 否              | 是(从3.0.3.0开始,该配置废弃) |                    |
| 24  |     statusInterval     | 是              | 是                              |                    |
| 25  |         logDir         | 是              | 是                              |                    |
| 26  |    minimalLogDirGB     | 是              | 是                              |                    |
| 27  |     numOfLogLines      | 是              | 是                              |                    |
| 28  |        asyncLog        | 是              | 是                              |                    |
| 29  |      logKeepDays       | 是              | 是                              |                    |
| 30  |       debugFlag        | 是              | 是                              |                    |
| 31  |      tmrDebugFlag      | 是              | 是                              |                    |
| 32  |       uDebugFlag       | 是              | 是                              |                    |
| 33  |      rpcDebugFlag      | 是              | 是                              |                    |
| 34  |      jniDebugFlag      | 是              | 是                              |                    |
| 35  |       qDebugFlag       | 是              | 是                              |                    |
| 36  |       cDebugFlag       | 是              | 是                              |                    |
| 37  |       dDebugFlag       | 是              | 是                              |                    |
| 38  |       vDebugFlag       | 是              | 是                              |                    |
| 39  |       mDebugFlag       | 是              | 是                              |                    |
| 40  |       wDebugFlag       | 是              | 是                              |                    |
| 41  |       sDebugFlag       | 是              | 是                              |                    |
| 42  |     tsdbDebugFlag      | 是              | 是                              |                    |
| 43  |      tqDebugFlag       | 否              | 是                              |                    |
| 44  |      fsDebugFlag       | 是              | 是                              |                    |
| 45  |      udfDebugFlag      | 否              | 是                              |                    |
| 46  |      smaDebugFlag      | 否              | 是                              |                    |
| 47  |      idxDebugFlag      | 否              | 是                              |                    |
| 48  |      tdbDebugFlag      | 否              | 是                              |                    |
| 49  |     metaDebugFlag      | 否              | 是                              |                    |
| 50  |        timezone        | 是              | 是                              |                    |
| 51  |         locale         | 是              | 是                              |                    |
| 52  |        charset         | 是              | 是                              |                    |
| 53  |          udf           | 是              | 是                              |                    |
| 54  |     enableCoreFile     | 是              | 是                              |                    |
805
| 55  |    ttlChangeOnWrite    | 否              | 是                              |                    |
806
| 56  |     keepTimeOffset     | 是              | 是                              |                    |
G
gccgdb1234 已提交
807 808 809

## 2.x->3.0 的废弃参数

dengyihao's avatar
dengyihao 已提交
810 811 812 813 814 815 816 817 818 819 820
| #   |        **参数**         | **适用于 2.X ** | **适用于 3.0 ** | 3.0 版本的当前行为                                   |
| --- | :---------------------: | --------------- | --------------- | ---------------------------------------------------- |
| 1   |       arbitrator        | 是              | 否              | 通过 RAFT 协议选主                                   |
| 2   |   numOfThreadsPerCore   | 是              | 否              | 有其它参数设置多种线程池的大小                       |
| 3   |       numOfMnodes       | 是              | 否              | 通过 create mnode 命令动态创建 mnode                 |
| 4   |        vnodeBak         | 是              | 否              | 3.0 行为未知                                         |
| 5   |         balance         | 是              | 否              | 负载均衡功能由 split/merge vgroups 实现 (暂不支持) |
| 6   |     balanceInterval     | 是              | 否              | 随着 balance 参数失效                                |
| 7   |    offlineThreshold     | 是              | 否              | 3.0 行为未知                                         |
| 8   |          role           | 是              | 否              | 由 supportVnode 决定是否能够创建                     |
| 9   |      dnodeNopLoop       | 是              | 否              | 2.6 文档中未找到此参数                               |
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
| 10  |        rpcTimer         | 是              | 否              | 3.0 行为未知                                         |
| 11  |       rpcMaxTime        | 是              | 否              | 3.0 行为未知                                         |
| 12  |       rpcForceTcp       | 是              | 否              | 默认为 TCP                                           |
| 13  |     tcpConnTimeout      | 是              | 否              | 3.0 行为未知                                         |
| 14  |    syncCheckInterval    | 是              | 否              | 3.0 行为未知                                         |
| 15  |       maxTmrCtrl        | 是              | 否              | 3.0 行为未知                                         |
| 16  |     monitorReplica      | 是              | 否              | 由 RAFT 协议管理多副本                               |
| 17  |     smlTagNullName      | 是              | 否              | 3.0 行为未知                                         |
| 18  |    ratioOfQueryCores    | 是              | 否              | 由 线程池 相关配置参数决定                           |
| 19  |   maxStreamCompDelay    | 是              | 否              | 3.0 行为未知                                         |
| 20  | maxFirstStreamCompDelay | 是              | 否              | 3.0 行为未知                                         |
| 21  |  retryStreamCompDelay   | 是              | 否              | 3.0 行为未知                                         |
| 22  |  streamCompDelayRatio   | 是              | 否              | 3.0 行为未知                                         |
| 23  |     maxVgroupsPerDb     | 是              | 否              | 由 create db 的参数 vgroups 指定实际 vgroups 数量    |
| 24  |    maxTablesPerVnode    | 是              | 否              | DB 中的所有表近似平均分配到各个 vgroup               |
| 25  |    minTablesPerVnode    | 是              | 否              | DB 中的所有表近似平均分配到各个 vgroup               |
| 26  |  tableIncStepPerVnode   | 是              | 否              | DB 中的所有表近似平均分配到各个 vgroup               |
| 27  |          cache          | 是              | 否              | 由 buffer 代替 cache\*blocks                         |
| 28  |         blocks          | 是              | 否              | 由 buffer 代替 cache\*blocks                         |
| 29  |          days           | 是              | 否              | 由 create db 的参数 duration 取代                    |
| 30  |          keep           | 是              | 否              | 由 create db 的参数 keep 取代                        |
| 31  |         minRows         | 是              | 否              | 由 create db 的参数 minRows 取代                     |
| 32  |         maxRows         | 是              | 否              | 由 create db 的参数 maxRows 取代                     |
| 33  |         quorum          | 是              | 否              | 由 RAFT 协议决定                                     |
| 34  |          comp           | 是              | 否              | 由 create db 的参数 comp 取代                        |
| 35  |        walLevel         | 是              | 否              | 由 create db 的参数 wal_level 取代                   |
| 36  |          fsync          | 是              | 否              | 由 create db 的参数 wal_fsync_period 取代            |
| 37  |         replica         | 是              | 否              | 由 create db 的参数 replica 取代                     |
| 38  |       partitions        | 是              | 否              | 3.0 行为未知                                         |
| 39  |         update          | 是              | 否              | 允许更新部分列                                       |
| 40  |        cachelast        | 是              | 否              | 由 create db 的参数 cacheModel 取代                  |
| 41  |      maxSQLLength       | 是              | 否              | SQL 上限为 1MB,无需参数控制                         |
| 42  |   maxWildCardsLength    | 是              | 否              | 3.0 行为未知                                         |
| 43  |    maxRegexStringLen    | 是              | 否              | 3.0 行为未知                                         |
| 44  |   maxNumOfOrderedRes    | 是              | 否              | 3.0 行为未知                                         |
| 45  |     maxConnections      | 是              | 否              | 取决于系统配置和系统处理能力,详见后面的 Note        |
| 46  |   mnodeEqualVnodeNum    | 是              | 否              | 3.0 行为未知                                         |
| 47  |          http           | 是              | 否              | http 服务由 taosAdapter 提供                         |
| 48  |   httpEnableRecordSql   | 是              | 否              | taosd 不提供 http 服务                               |
| 49  |     httpMaxThreads      | 是              | 否              | taosd 不提供 http 服务                               |
| 50  |     restfulRowLimit     | 是              | 否              | taosd 不提供 http 服务                               |
| 51  |   httpDbNameMandatory   | 是              | 否              | taosd 不提供 http 服务                               |
| 52  |      httpKeepAlive      | 是              | 否              | taosd 不提供 http 服务                               |
| 53  |     enableRecordSql     | 是              | 否              | 3.0 行为未知                                         |
| 54  |  maxBinaryDisplayWidth  | 是              | 否              | 3.0 行为未知                                         |
| 55  |         stream          | 是              | 否              | 默认启用连续查询                                     |
| 56  |  retrieveBlockingModel  | 是              | 否              | 3.0 行为未知                                         |
| 57  |  tsdbMetaCompactRatio   | 是              | 否              | 3.0 行为未知                                         |
| 58  |   defaultJSONStrType    | 是              | 否              | 3.0 行为未知                                         |
| 59  |      walFlushSize       | 是              | 否              | 3.0 行为未知                                         |
| 60  |        flowctrl         | 是              | 否              | 3.0 行为未知                                         |
| 61  |       slaveQuery        | 是              | 否              | 3.0 行为未知: slave vnode 是否能够处理查询?        |
| 62  |      adjustMaster       | 是              | 否              | 3.0 行为未知                                         |
| 63  |     topicBinaryLen      | 是              | 否              | 3.0 行为未知                                         |
| 64  |   telegrafUseFieldNum   | 是              | 否              | 3.0 行为未知                                         |
| 65  |    deadLockKillQuery    | 是              | 否              | 3.0 行为未知                                         |
| 66  |       clientMerge       | 是              | 否              | 3.0 行为未知                                         |
| 67  |      sdbDebugFlag       | 是              | 否              | 参考 3.0 的 DebugFlag 系列参数                       |
| 68  |      odbcDebugFlag      | 是              | 否              | 参考 3.0 的 DebugFlag 系列参数                       |
| 69  |      httpDebugFlag      | 是              | 否              | 参考 3.0 的 DebugFlag 系列参数                       |
| 70  |      monDebugFlag       | 是              | 否              | 参考 3.0 的 DebugFlag 系列参数                       |
| 71  |       cqDebugFlag       | 是              | 否              | 参考 3.0 的 DebugFlag 系列参数                       |
| 72  |      shortcutFlag       | 是              | 否              | 参考 3.0 的 DebugFlag 系列参数                       |
| 73  |      probeSeconds       | 是              | 否              | 3.0 行为未知                                         |
| 74  |    probeKillSeconds     | 是              | 否              | 3.0 行为未知                                         |
| 75  |      probeInterval      | 是              | 否              | 3.0 行为未知                                         |
| 76  |      lossyColumns       | 是              | 否              | 3.0 行为未知                                         |
| 77  |       fPrecision        | 是              | 否              | 3.0 行为未知                                         |
| 78  |       dPrecision        | 是              | 否              | 3.0 行为未知                                         |
| 79  |        maxRange         | 是              | 否              | 3.0 行为未知                                         |
| 80  |          range          | 是              | 否              | 3.0 行为未知                                         |