index.md 38.9 KB
Newer Older
1 2 3 4 5 6 7 8 9
---
title: Configuration Parameters
description: "Configuration parameters for client and server in TDengine"
---

## Configuration File on Server Side

On the server side, the actual service of TDengine is provided by an executable `taosd` whose parameters can be configured in file `taos.cfg` to meet the requirements of different use cases. The default location of `taos.cfg` is `/etc/taos`, but can be changed by using `-c` parameter on the CLI of `taosd`. For example, the configuration file can be put under `/home/user` and used like below

D
danielclow 已提交
10
```
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
taosd -c /home/user
```

Parameter `-C` can be used on the CLI of `taosd` to show its configuration, like below:

```
taosd -C
```

## Configuration File on Client Side

TDengine CLI `taos` is the tool for users to interact with TDengine. It can share same configuration file as `taosd` or use a separate configuration file. When launching `taos`, parameter `-c` can be used to specify the location where its configuration file is. For example `taos -c /home/cfg` means `/home/cfg/taos.cfg` will be used. If `-c` is not used, the default location of the configuration file is `/etc/taos`. For more details please use `taos --help` to get.

```bash
taos -C
```

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

# Configuration Parameters

D
danielclow 已提交
34 35 36 37 38
:::note
The parameters described in this document by the effect that they have on the system.

:::

39 40 41 42 43 44 45 46 47
:::note
`taosd` needs to be restarted for the parameters changed in the configuration file to take effect.

:::

## Connection Parameters

### firstEp

D
danielclow 已提交
48 49 50
| Attribute     | Description                            |
| -------- | -------------------------------------------------------------- |
| Applicable | Server and Client                                           |
51
| Meaning       | The end point of the first dnode in the cluster to be connected to when `taosd` or `taos` is started |
D
danielclow 已提交
52
| Default   | localhost:6030                                                 |
53 54 55

### secondEp

D
danielclow 已提交
56 57 58
| Attribute     | Description                                                                                  |
| -------- | ------------------------------------------------------------------------------------- |
| Applicable | Server and Client                                           |
59
| Meaning       | The end point of the second dnode to be connected to if the firstEp is not available when `taosd` or `taos` is started |
D
danielclow 已提交
60
| Default   | None                                                                                    |
61 62 63 64 65 66 67

### fqdn

| Attribute     | Description                                                              |
| ------------- | ------------------------------------------------------------------------ |
| Applicable    | Server Only                                                              |
| Meaning       | The FQDN of the host where `taosd` will be started. It can be IP address |
D
danielclow 已提交
68 69
| Default Value | The first hostname configured for the host                             |
| Note          | It should be within 96 bytes                                             |                        |
70 71 72

### serverPort

D
danielclow 已提交
73 74 75
| Attribute     | Description                                                              |
| -------- | ----------------------------------------------------------------------------------------------------------------------- |
| Applicable    | Server Only                                                              |
76 77 78 79
| Meaning       | The port for external access after `taosd` is started                                                                           |
| Default Value | 6030                                                                                                                            |

:::note
D
danielclow 已提交
80
- Ensure that your firewall rules do not block TCP port 6042  on any host in the cluster. Below table describes the ports used by TDengine in details.
81 82 83
:::
| Protocol | Default Port | Description                                      | How to configure                                                                               |
| :------- | :----------- | :----------------------------------------------- | :--------------------------------------------------------------------------------------------- |
D
danielclow 已提交
84
| TCP | 6030 | Communication between client and server. In a multi-node cluster, communication between nodes. serverPort |
85
| TCP      | 6041         | REST connection between client and server        | Prior to 2.4.0.0: serverPort+11; After 2.4.0.0 refer to [taosAdapter](/reference/taosadapter/) |
D
danielclow 已提交
86 87 88 89
| TCP      | 6043         | Service Port of TaosKeeper                       | The parameter of TaosKeeper |
| TCP      | 6044         | Data access port for StatsD                      | Configurable through taosAdapter parameters.
| UDP      | 6045         | Data access for statsd                           | Configurable through taosAdapter parameters.
| TCP      | 6060         | Port of Monitoring Service in Enterprise version | |
90 91 92 93 94 95 96 97 98 99

### maxShellConns

| Attribute     | Description                                          |
| ------------- | ---------------------------------------------------- |
| Applicable    | Server Only                                          |
| Meaning       | The maximum number of connections a dnode can accept |
| Value Range   | 10-50000000                                          |
| Default Value | 5000                                                 |

D
danielclow 已提交
100
## Monitoring Parameters
101

D
danielclow 已提交
102
### monitor
103

D
danielclow 已提交
104 105 106 107 108
| Attribute     | Description                                                                                                                                                                                               |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Applicable | Server only                                           |
| Meaning       | The switch for monitoring inside server. The main object of monitoring is to collect information about load on physical nodes, including CPU usage, memory usage, disk usage, and network bandwidth. Monitoring information is sent over HTTP to the taosKeeper service specified by `monitorFqdn` and `monitorProt`.
| Value Range   | 0: monitoring disabled, 1: monitoring enabled                                                                                                                                                                |
S
Shengliang Guan 已提交
109
| Default   | 1                                                                                                                                                                                                  |
110

D
danielclow 已提交
111
### monitorFqdn
112

D
danielclow 已提交
113 114 115 116 117
| Attribute     | Description                                                    |
| -------- | -------------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | FQDN of taosKeeper monitoring service |
| Default   | None                                                                                    |
118

D
danielclow 已提交
119
### monitorPort
120

D
danielclow 已提交
121 122 123 124 125
| Attribute     | Description                            |
| -------- | --------------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | Port of taosKeeper monitoring service |
| Default Value | 6043                                                               |
126 127 128

### monitorInterval

D
danielclow 已提交
129 130 131
| Attribute     | Description                                                                                                                                                                         |
| -------- | -------------------------------------------- |
| Applicable    | Server Only                                                                                                                                                                         |
132 133
| Meaning       | The interval of collecting system workload |
| Unit          | second                                     |
D
danielclow 已提交
134 135
| Value Range | 1-200000                                     |
| Default Value | 30                                                                                                                                                                                   |
136 137 138

### telemetryReporting

D
danielclow 已提交
139 140 141
| Attribute     | Description                                                                                                                                                                         |
| -------- | ---------------------------------------- |
| Applicable    | Server Only                                                                                                                                                                         |
142 143
| Meaning       | Switch for allowing TDengine to collect and report service usage information |
| Value Range   | 0: Not allowed; 1: Allowed                                                   |
D
danielclow 已提交
144
| Default Value | 1                                                                                                                                                                                   |
145 146 147

## Query Parameters

D
danielclow 已提交
148
### queryPolicy
149

D
danielclow 已提交
150 151 152 153 154 155 156
| Attribute     | Description                          |
| -------- | ----------------------------- |
| Applicable | Client only                                           |
| Meaning     | Execution policy for query statements            |
| Unit     | None                            |
| Default   | 1                             |
| Notes | 1: Run queries on vnodes and not on qnodes |
157

D
danielclow 已提交
158 159 160 161 162 163 164 165 166
2: Run subtasks without scan operators on qnodes and subtasks with scan operators on vnodes.

3: Only run scan operators on vnodes; run all other operators on qnodes.

### querySmaOptimize

| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable | Client only                                           |
167
| Meaning  | SMA index optimization policy |
D
danielclow 已提交
168 169 170 171 172 173 174
| Unit     | None                            |
| Default Value | 0                                                 |
| Notes |

0: Disable SMA indexing and perform all queries on non-indexed data.

1: Enable SMA indexing and perform queries from suitable statements on precomputation results.|
175 176 177 178


### maxNumOfDistinctRes

D
danielclow 已提交
179
| Attribute     | Description                                                                                                                                                                         |
180
| -------- | -------------------------------- |
D
danielclow 已提交
181
| Applicable    | Server Only                                                                                                                                                                         |
182
| Meaning       | The maximum number of distinct rows returned |
S
Sean Ely 已提交
183 184
| Value Range   | [100,000 - 100,000,000]                      |
| Default Value | 100,000                                      |
185

186 187 188 189 190 191 192 193 194
### keepColumnName

| Attribute     | Description                             |
| -------- | -------------------------------- |
| Applicable | Client only                     |
| Meaning     | When the Last, First, LastRow function is queried, whether the returned column name contains the function name. |
| Value Range | 0 means including the function name, 1 means not including the function name.     |
| Default Value   | 0                            |

195 196 197 198
## Locale Parameters

### timezone

D
danielclow 已提交
199 200 201
| Attribute     | Description                                                                                                                                                                         |
| -------- | ------------------------------ |
| Applicable    | Server and Client                                                                                                      |
202 203 204 205
| Meaning       | TimeZone                        |
| Default Value | TimeZone configured in the host |

:::info
D
danielclow 已提交
206
To handle the data insertion and data query from multiple timezones, Unix Timestamp is used and stored in TDengine. The timestamp generated from any timezones at same time is same in Unix timestamp. Note that Unix timestamps are converted and recorded on the client side. To make sure the time on client side can be converted to Unix timestamp correctly, the timezone must be set properly.
207

wafwerar's avatar
wafwerar 已提交
208
On Linux/macOS, TDengine clients automatically obtain timezone from the host. Alternatively, the timezone can be configured explicitly in configuration file `taos.cfg` like below. For example:
209 210

```
D
danielclow 已提交
211
timezone UTC-8
212 213 214 215 216 217
timezone GMT-8
timezone Asia/Shanghai
```

The above examples are all proper configuration for the timezone of UTC+8. On Windows system, however, `timezone Asia/Shanghai` is not supported, it must be set as `timezone UTC-8`.

218
The setting for timezone impacts strings that are not in Unix timestamp format and keywords or functions related to date/time. For example:
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235

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

If the timezone is UTC+8, the above SQL statement is equal to:

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

If the timezone is UTC, it's equal to

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

236
To avoid the problems of using time strings, Unix timestamp can be used directly. Furthermore, time strings with timezone can be used in SQL statements. For example "2013-04-12T15:52:01.123+08:00" in RFC3339 format or "2013-04-12T15:52:01.123+0800" in ISO-8601 format are not influenced by timezone setting when converted to Unix timestamp.
237 238 239 240 241 242 243 244 245 246 247 248

:::

### locale

| Attribute     | Description               |
| ------------- | ------------------------- |
| Applicable    | Server and Client         |
| Meaning       | Location code             |
| Default Value | Locale configured in host |

:::info
D
danielclow 已提交
249
A specific type "nchar" is provided in TDengine to store non-ASCII characters such as Chinese, Japanese, and Korean. The characters to be stored in nchar type are firstly encoded in UCS4-LE before sending to server side. Note that the correct encoding is determined by the user. To store non-ASCII characters correctly, the encoding format of the client side needs to be set properly.
250

wafwerar's avatar
wafwerar 已提交
251
The characters input on the client side are encoded using the default system encoding, which is UTF-8 on Linux/macOS, or GB18030 or GBK on some systems in Chinese, POSIX in docker, CP936 on Windows in Chinese. The encoding of the operating system in use must be set correctly so that the characters in nchar type can be converted to UCS4-LE.
252

wafwerar's avatar
wafwerar 已提交
253
The locale definition standard on Linux/macOS is: <Language\>\_<Region\>.<charset\>, for example, in "zh_CN.UTF-8", "zh" means Chinese, "CN" means China mainland, "UTF-8" means charset. The charset indicates how to display the characters. On Linux/macOS, the charset can be set by locale in the system. On Windows system another configuration parameter `charset` must be used to configure charset because the locale used on Windows is not POSIX standard. Of course, `charset` can also be used on Linux/macOS to specify the charset.
254 255 256 257 258 259 260 261 262 263 264 265

:::

### charset

| Attribute     | Description               |
| ------------- | ------------------------- |
| Applicable    | Server and Client         |
| Meaning       | Character                 |
| Default Value | charset set in the system |

:::info
wafwerar's avatar
wafwerar 已提交
266
On Linux/macOS, if `charset` is not set in `taos.cfg`, when `taos` is started, the charset is obtained from system locale. If obtaining charset from system locale fails, `taos` would fail to start.
D
danielclow 已提交
267

wafwerar's avatar
wafwerar 已提交
268
So on Linux/macOS, if system locale is set properly, it's not necessary to set `charset` in `taos.cfg`. For example:
269 270 271 272 273

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

D
danielclow 已提交
274 275 276 277 278 279 280 281
On Windows system, it's not possible to obtain charset from system locale. If it's not set in configuration file `taos.cfg`, it would be default to CP936, same as set as below in `taos.cfg`. For example

```
charset CP936
```

Refer to the documentation for your operating system before changing the charset.

wafwerar's avatar
wafwerar 已提交
282
On a Linux/macOS, if the charset contained in `locale` is not consistent with that set by `charset`, the later setting in the configuration file takes precedence.
283

D
danielclow 已提交
284
```
285 286 287 288
locale zh_CN.UTF-8
charset GBK
```

D
danielclow 已提交
289 290 291
The charset that takes effect is GBK.

```
292 293 294 295
charset GBK
locale zh_CN.UTF-8
```

D
danielclow 已提交
296
The charset that takes effect is UTF-8.
297 298 299 300 301 302 303

:::

## Storage Parameters

### dataDir

D
danielclow 已提交
304 305
| Attribute     | Description               |
| -------- | ------------------------------------------ |
306 307 308 309 310 311
| Applicable    | Server Only                                 |
| Meaning       | All data files are stored in this directory |
| Default Value | /var/lib/taos                               |

### minimalTmpDirGB

D
danielclow 已提交
312 313 314
| Attribute     | Description                            |
| -------- | ------------------------------------------------ |
| Applicable    | Server and Client         |
315
| Meaning       | When the available disk space in tmpDir is below this threshold, writing to tmpDir is suspended |
D
danielclow 已提交
316 317
| Unit          | GB                            |
| Default Value | 1.0                                                                   |
318 319 320

### minimalDataDirGB

D
danielclow 已提交
321 322 323 324 325 326
| Attribute     | Description                            |
| -------- | ------------------------------------------------ |
| Applicable    | Server Only                                                    |
| Meaning       | When the available disk space in dataDir is below this threshold, writing to dataDir is suspended |
| Unit          | GB                            |
| Default Value | 2.0                                                                   |
327 328 329

## Cluster Parameters

D
danielclow 已提交
330
### supportVnodes
331

D
danielclow 已提交
332 333 334 335 336
| Attribute     | Description                            |
| -------- | --------------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | Maximum number of vnodes per dnode |
| Value Range | 0-4096                                     |
337
| Default Value | 2x the CPU cores                                                    |
338 339 340 341 342

## Time Parameters

### statusInterval

D
danielclow 已提交
343 344 345
| Attribute     | Description                            |
| -------- | --------------------------- |
| Applicable    | Server Only                                                    |
346 347
| Meaning       | the interval of dnode reporting status to mnode |
| Unit          | second                                          |
D
danielclow 已提交
348 349
| Value Range   | 1-10                                         |
| Default Value | 1                          |
350 351 352

### shellActivityTimer

D
danielclow 已提交
353 354 355
| Attribute     | Description                            |
| -------- | --------------------------------- |
| Applicable    | Server and Client         |
356
| Meaning       | The interval for TDengine CLI to send heartbeat to mnode |
D
danielclow 已提交
357 358 359
| Unit          | second                                          |
| Value Range   | 1-120                                         |
| Default Value | 3                              |
360 361 362 363 364

## Performance Optimization Parameters

### numOfCommitThreads

D
danielclow 已提交
365 366 367
| Attribute     | Description                            |
| -------- | ---------------------- |
| Applicable    | Server Only                                                    |
368
| Meaning       | Maximum of threads for committing to disk |
D
danielclow 已提交
369
| Default Value | |
370 371 372 373 374

## Compression Parameters

### compressMsgSize

D
danielclow 已提交
375 376 377 378
| Attribute     | Description                                                                                                                                                                         |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Applicable    | Server Only                                                                                                                                                                         |
| Meaning       | The threshold for message size to compress the message.                         | Set the value to 64330 bytes for good message compression. |
379 380
| Unit          | bytes                                                                            |
| Value Range   | 0: already compress; >0: compress when message exceeds it; -1: always uncompress |
D
danielclow 已提交
381
| Default Value | -1                                                               |
382 383 384

### compressColData

D
danielclow 已提交
385 386 387 388
| Attribute     | Description                            |
| -------- | --------------------------------------------------------------------------------------- |
| Applicable    | Server Only                                                    |
| Meaning       | The threshold for size of column data to trigger compression for the query result              |
389 390
| Unit          | bytes                                                                                                               |
| Value Range   | 0: always compress; >0: only compress when the size of any column data exceeds the threshold; -1: always uncompress |
D
danielclow 已提交
391
| Default Value | -1                                                               |
392
| Default Value | -1                                                                                                                  |
393
| Note          | available from version 2.3.0.0                                                                                      |                                                                                                                       |
394

395
## Continuous Query Parameters                                  |
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425

### minSlidingTime

| Attribute     | Description                                              |
| ------------- | -------------------------------------------------------- |
| Applicable    | Server Only                                              |
| Meaning       | Minimum sliding time of time window                      |
| Unit          | millisecond or microsecond , depending on time precision |
| Value Range   | 10-1000000                                               |
| Default Value | 10                                                       |

### minIntervalTime

| Attribute     | Description                 |
| ------------- | --------------------------- |
| Applicable    | Server Only                 |
| Meaning       | Minimum size of time window |
| Unit          | millisecond                 |
| Value Range   | 1-1000000                   |
| Default Value | 10                          |

:::info
To prevent system resource from being exhausted by multiple concurrent streams, a random delay is applied on each stream automatically. `maxFirstStreamCompDelay` is the maximum delay time before a continuous query is started the first time. `streamCompDelayRatio` is the ratio for calculating delay time, with the size of the time window as base. `maxStreamCompDelay` is the maximum delay time. The actual delay time is a random time not bigger than `maxStreamCompDelay`. If a continuous query fails, `retryStreamComDelay` is the delay time before retrying it, also not bigger than `maxStreamCompDelay`.

:::

## Log Parameters

### logDir

D
danielclow 已提交
426 427 428
| Attribute     | Description                            |
| -------- | -------------------------------------------------- |
| Applicable    | Server and Client         |
429 430 431 432 433
| Meaning       | The directory for writing log files |
| Default Value | /var/log/taos                       |

### minimalLogDirGB

D
danielclow 已提交
434 435 436
| Attribute     | Description                                                                                                                                                                         |
| -------- | -------------------------------------------- |
| Applicable    | Server and Client         |
437
| Meaning       | When the available disk space in logDir is below this threshold, writing to log files is suspended |
D
danielclow 已提交
438 439
| Unit          | GB                            |
| Default Value | 1.0                              |
440 441 442

### numOfLogLines

D
danielclow 已提交
443 444 445
| Attribute     | Description                            |
| -------- | ---------------------------- |
| Applicable    | Server and Client         |
446
| Meaning       | Maximum number of lines in single log file |
D
danielclow 已提交
447
| Default Value | 10000000                            |
448 449 450

### asyncLog

D
danielclow 已提交
451 452 453
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server and Client         |
454 455
| Meaning       | The mode of writing log file |
| Value Range   | 0: sync way; 1: async way    |
D
danielclow 已提交
456
| Default Value | 1                                                 |
457 458 459

### logKeepDays

D
danielclow 已提交
460 461 462
| Attribute     | Description                            |
| -------- | ----------------------------------------------------------------------------------- |
| Applicable    | Server and Client         |
463
| Meaning       | The number of days for log files to be kept                                                                                                 |
D
danielclow 已提交
464 465
| Unit          | day                                                   |
| Default Value | 0                                                               |
466 467 468 469
| Note          | When it's bigger than 0, the log file would be renamed to "taosdlog.xxx" in which "xxx" is the timestamp when the file is changed last time |

### debugFlag

D
danielclow 已提交
470 471 472
| Attribute     | Description                            |
| -------- | ------------------------------------------------------------------------------------------------- |
| Applicable    | Server and Client         |
473 474 475 476
| Meaning       | Log level                                                 |
| Value Range   | 131: INFO/WARNING/ERROR; 135: plus DEBUG; 143: plus TRACE |
| Default Value | 131 or 135, depending on the module                       |

D
danielclow 已提交
477
### tmrDebugFlag
478

D
danielclow 已提交
479 480 481 482
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server and Client         |
| Meaning       | Log level of timer module |
483
| Value Range   | same as debugFlag  |
D
danielclow 已提交
484
| Default Value | |
485

D
danielclow 已提交
486
### uDebugFlag
487

D
danielclow 已提交
488 489 490 491
| Attribute     | Description                            |
| -------- | ---------------------- |
| Applicable    | Server and Client         |
| Meaning       | Log level of common module |
492
| Value Range   | same as debugFlag  |
D
danielclow 已提交
493
| Default Value | |
494 495 496

### rpcDebugFlag

D
danielclow 已提交
497 498 499
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server and Client         |
500
| Meaning       | Log level of rpc module |
D
danielclow 已提交
501 502
| Value Range   | same as debugFlag  |
| Default Value | |
503

D
danielclow 已提交
504
### jniDebugFlag
505

D
danielclow 已提交
506 507 508 509 510 511 512 513 514 515 516
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Client Only         |
| Meaning       | Log level of jni module |
| Value Range   | same as debugFlag  |
| Default Value | |

### qDebugFlag

| Attribute     | Description                            |
| -------- | -------------------- |
517
| Applicable    | Server and Client         |
D
danielclow 已提交
518 519 520
| Meaning     | Log level of query module |
| Value Range   | same as debugFlag  |
| Default Value | |
521 522 523

### cDebugFlag

D
danielclow 已提交
524 525
| Attribute     | Description                            |
| -------- | --------------------- |
526 527
| Applicable    | Client Only         |
| Meaning       | Log level of Client |
D
danielclow 已提交
528 529
| Value Range   | same as debugFlag  |
| Default Value | |
530

D
danielclow 已提交
531
### dDebugFlag
532

D
danielclow 已提交
533 534 535 536 537 538
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning       | Log level of dnode |
| Value Range   | same as debugFlag  |
| Default Value | 135                              |
539

D
danielclow 已提交
540
### vDebugFlag
541

D
danielclow 已提交
542 543 544 545 546 547
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning       | Log level of vnode |
| Value Range   | same as debugFlag  |
| Default Value | |
548

D
danielclow 已提交
549
### mDebugFlag
550

D
danielclow 已提交
551 552 553 554 555 556
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of mnode module |
| Value Range   | same as debugFlag  |
| Default Value | 135                              |
557

D
danielclow 已提交
558
### wDebugFlag
559

D
danielclow 已提交
560 561 562 563 564 565
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of WAL module |
| Value Range   | same as debugFlag  |
| Default Value | 135                          |
566

D
danielclow 已提交
567
### sDebugFlag
568

D
danielclow 已提交
569 570
| Attribute     | Description                            |
| -------- | -------------------- |
571
| Applicable    | Server and Client         |
D
danielclow 已提交
572 573 574
| Meaning       | Log level of sync module |
| Value Range   | same as debugFlag  |
| Default Value | 135                              |
575 576 577

### tsdbDebugFlag

D
danielclow 已提交
578 579 580 581 582 583
| Attribute     | Description                            |
| -------- | ------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of TSDB module |
| Value Range   | same as debugFlag  |
| Default Value | |
584

D
danielclow 已提交
585
### tqDebugFlag
586 587

| Attribute     | Description                          |
D
danielclow 已提交
588 589 590 591 592
| -------- | ----------------- |
| Applicable | Server only                                           |
| Meaning     | Log level of TQ module |
| Value Range   | same as debugFlag  |
| Default Value | |
593

D
danielclow 已提交
594
### fsDebugFlag
595

D
danielclow 已提交
596 597 598 599 600 601 602 603
| Attribute     | Description                          |
| -------- | ----------------- |
| Applicable | Server only                                           |
| Meaning     | Log level of FS module |
| Value Range   | same as debugFlag  |
| Default Value | |

### udfDebugFlag
604 605

| Attribute     | Description                            |
D
danielclow 已提交
606 607 608 609 610
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning       | Log level of UDF module |
| Value Range   | same as debugFlag  |
| Default Value | |
611

D
danielclow 已提交
612
### smaDebugFlag
613

D
danielclow 已提交
614 615 616 617 618 619
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of SMA module |
| Value Range   | same as debugFlag  |
| Default Value | |
620

D
danielclow 已提交
621
### idxDebugFlag
622

D
danielclow 已提交
623 624 625 626 627 628
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of index module |
| Value Range   | same as debugFlag  |
| Default Value | |
629

D
danielclow 已提交
630
### tdbDebugFlag
631

D
danielclow 已提交
632 633 634 635 636 637
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of TDB module |
| Value Range   | same as debugFlag  |
| Default Value | |
638

D
danielclow 已提交
639
## Schemaless Parameters
640

D
danielclow 已提交
641
### smlChildTableName
642

D
danielclow 已提交
643 644 645 646 647 648
| Attribute     | Description                      |
| -------- | ------------------------- |
| Applicable | Client only                                           |
| Meaning     | Custom subtable name for schemaless writes |
| Type     | String                    |
| Default Value   | None                        |
649

D
danielclow 已提交
650
### smlTagName
651

D
danielclow 已提交
652 653 654 655 656 657 658 659
| Attribute     | Description                            |
| -------- | ------------------------------------ |
| Applicable | Client only                                           |
| Meaning     | Default tag for schemaless writes without tag value specified |
| Type     | String                    |
| Default Value   | _tag_null                                 |

### smlDataFormat
660 661

| Attribute     | Description                          |
D
danielclow 已提交
662 663 664 665 666
| -------- | ----------------------------- |
| Applicable | Client only                                           |
| Meaning     | Whether schemaless columns are consistently ordered |
| Value Range     | 0: not consistent; 1: consistent.            |
| Default   | 1                             |
667 668 669 670 671

## Other Parameters

### enableCoreFile

D
danielclow 已提交
672 673
| Attribute     | Description                                                                                         |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
674 675 676 677
| Applicable    | Server and Client                                                                                                                                                       |
| Meaning       | Whether to generate core file when server crashes                                                                                                                       |
| Value Range   | 0: false, 1: true                                                                                                                                                       |
| Default Value | 1                                                                                                                                                                       |
wafwerar's avatar
wafwerar 已提交
678
| Note          | The core file is generated under root directory `systemctl start taosd`/`launchctl start com.tdengine.taosd` is used to start, or under the working directory if `taosd` is started directly on Linux/macOS Shell. |
D
danielclow 已提交
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708

### udf

| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning     | Whether the UDF service is enabled  |
| Value Range   | 0: disable UDF; 1: enabled UDF |
| Default Value | 1                              |

## Parameter Comparison of TDengine 2.x and 3.0
| #   | **Parameter**             | **In 2.x** | **In 3.0** |
| --- | :-----------------: | ---------------    | ---------------   |
| 1   | firstEp | Yes | Yes |
| 2   | secondEp | Yes | Yes |
| 3   | fqdn | Yes | Yes |
| 4   | serverPort | Yes | Yes |
| 5   | maxShellConns | Yes | Yes |
| 6   | monitor | Yes | Yes |
| 7   | monitorFqdn | No | Yes |
| 8   | monitorPort | No | Yes |
| 9   | monitorInterval | Yes | Yes |
| 10  | monitorMaxLogs | No | Yes |
| 11  | monitorComp | No | Yes |
| 12  | telemetryReporting | Yes | Yes |
| 13  | telemetryInterval | No | Yes |
| 14  | telemetryServer | No | Yes |
| 15  | telemetryPort | No | Yes |
| 16  | queryPolicy | No | Yes |
| 17  | querySmaOptimize | No | Yes |
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
| 18  | queryRsmaTolerance | No | Yes |
| 19  | queryBufferSize | Yes | Yes |
| 20  | maxNumOfDistinctRes | Yes | Yes |
| 21  | minSlidingTime | Yes | Yes |
| 22  | minIntervalTime | Yes | Yes |
| 23  | countAlwaysReturnValue | Yes | Yes |
| 24  | dataDir | Yes | Yes |
| 25  | minimalDataDirGB | Yes | Yes |
| 26  | supportVnodes | No | Yes |
| 27  | tempDir | Yes | Yes |
| 28  | minimalTmpDirGB | Yes | Yes |
| 29  | compressMsgSize | Yes | Yes |
| 30  | compressColData | Yes | Yes |
| 31  | smlChildTableName | Yes | Yes |
| 32  | smlTagName | Yes | Yes |
| 33  | smlDataFormat | No | Yes |
| 34  | statusInterval | Yes | Yes |
| 35  | shellActivityTimer | Yes | Yes |
| 36  | transPullupInterval | No | Yes |
| 37  | mqRebalanceInterval | No | Yes |
| 38  | ttlUnit | No | Yes |
| 39  | ttlPushInterval | No | Yes |
| 40  | numOfTaskQueueThreads | No | Yes |
| 41  | numOfRpcThreads | No | Yes |
| 42  | numOfCommitThreads | Yes | Yes |
| 43  | numOfMnodeReadThreads | No | Yes |
| 44  | numOfVnodeQueryThreads | No | Yes |
| 45  | numOfVnodeStreamThreads | No | Yes |
| 46  | numOfVnodeFetchThreads | No | Yes |
738 739 740 741 742 743 744 745 746 747 748
| 47  | numOfVnodeRsmaThreads | No | Yes | 
| 48  | numOfQnodeQueryThreads | No | Yes |
| 49  | numOfQnodeFetchThreads | No | Yes |
| 50  | numOfSnodeSharedThreads | No | Yes |
| 51  | numOfSnodeUniqueThreads | No | Yes |
| 52  | rpcQueueMemoryAllowed | No | Yes |
| 53  | logDir | Yes | Yes |
| 54  | minimalLogDirGB | Yes | Yes |
| 55  | numOfLogLines | Yes | Yes |
| 56  | asyncLog | Yes | Yes |
| 57  | logKeepDays | Yes | Yes |
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 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 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
| 60  | debugFlag | Yes | Yes |
| 61  | tmrDebugFlag | Yes | Yes |
| 62  | uDebugFlag | Yes | Yes |
| 63  | rpcDebugFlag | Yes | Yes |
| 64  | jniDebugFlag | Yes | Yes |
| 65  | qDebugFlag | Yes | Yes |
| 66  | cDebugFlag | Yes | Yes |
| 67  | dDebugFlag | Yes | Yes |
| 68  | vDebugFlag | Yes | Yes |
| 69  | mDebugFlag | Yes | Yes |
| 70  | wDebugFlag | Yes | Yes |
| 71  | sDebugFlag | Yes | Yes |
| 72  | tsdbDebugFlag | Yes | Yes |
| 73  | tqDebugFlag | No | Yes |
| 74  | fsDebugFlag | Yes | Yes |
| 75  | udfDebugFlag | No | Yes |
| 76  | smaDebugFlag | No | Yes |
| 77  | idxDebugFlag | No | Yes |
| 78  | tdbDebugFlag | No | Yes |
| 79  | metaDebugFlag | No | Yes |
| 80  | timezone | Yes | Yes |
| 81  | locale | Yes | Yes |
| 82  | charset | Yes | Yes |
| 83  | udf | Yes | Yes |
| 84  | enableCoreFile | Yes | Yes |
| 85  | arbitrator | Yes | No |
| 86  | numOfThreadsPerCore | Yes | No |
| 87  | numOfMnodes | Yes | No |
| 88  | vnodeBak | Yes | No |
| 89  | balance | Yes | No |
| 90  | balanceInterval | Yes | No |
| 91  | offlineThreshold | Yes | No |
| 92  | role | Yes | No |
| 93  | dnodeNopLoop | Yes | No |
| 94  | keepTimeOffset | Yes | No |
| 95  | rpcTimer | Yes | No |
| 96  | rpcMaxTime | Yes | No |
| 97  | rpcForceTcp | Yes | No |
| 98  | tcpConnTimeout | Yes | No |
| 99  | syncCheckInterval | Yes | No |
| 100 | maxTmrCtrl | Yes | No |
| 101 | monitorReplica | Yes | No |
| 102 | smlTagNullName | Yes | No |
| 103 | keepColumnName | Yes | No |
| 104 | ratioOfQueryCores | Yes | No |
| 105 | maxStreamCompDelay | Yes | No |
| 106 | maxFirstStreamCompDelay | Yes | No |
| 107 | retryStreamCompDelay | Yes | No |
| 108 | streamCompDelayRatio | Yes | No |
| 109 | maxVgroupsPerDb | Yes | No |
| 110 | maxTablesPerVnode | Yes | No |
| 111 | minTablesPerVnode | Yes | No |
| 112 | tableIncStepPerVnode | Yes | No |
| 113 | cache | Yes | No |
| 114 | blocks | Yes | No |
| 115 | days | Yes | No |
| 116 | keep | Yes | No |
| 117 | minRows | Yes | No |
| 118 | maxRows | Yes | No |
| 119 | quorum | Yes | No |
| 120 | comp | Yes | No |
| 121 | walLevel | Yes | No |
| 122 | fsync | Yes | No |
| 123 | replica | Yes | No |
| 124 | partitions | Yes | No |
| 125 | quorum | Yes | No |
| 126 | update | Yes | No |
| 127 | cachelast | Yes | No |
| 128 | maxSQLLength | Yes | No |
| 129 | maxWildCardsLength | Yes | No |
| 130 | maxRegexStringLen | Yes | No |
| 131 | maxNumOfOrderedRes | Yes | No |
| 132 | maxConnections | Yes | No |
| 133 | mnodeEqualVnodeNum | Yes | No |
| 134 | http | Yes | No |
| 135 | httpEnableRecordSql | Yes | No |
| 136 | httpMaxThreads | Yes | No |
| 137 | restfulRowLimit | Yes | No |
| 138 | httpDbNameMandatory | Yes | No |
| 139 | httpKeepAlive | Yes | No |
| 140 | enableRecordSql | Yes | No |
| 141 | maxBinaryDisplayWidth | Yes | No |
| 142 | stream | Yes | No |
| 143 | retrieveBlockingModel | Yes | No |
| 144 | tsdbMetaCompactRatio | Yes | No |
| 145 | defaultJSONStrType | Yes | No |
| 146 | walFlushSize | Yes | No |
| 147 | keepTimeOffset | Yes | No |
| 148 | flowctrl | Yes | No |
| 149 | slaveQuery | Yes | No |
| 150 | adjustMaster | Yes | No |
| 151 | topicBinaryLen | Yes | No |
| 152 | telegrafUseFieldNum | Yes | No |
| 153 | deadLockKillQuery | Yes | No |
| 154 | clientMerge | Yes | No |
| 155 | sdbDebugFlag | Yes | No |
| 156 | odbcDebugFlag | Yes | No |
| 157 | httpDebugFlag | Yes | No |
| 158 | monDebugFlag | Yes | No |
| 159 | cqDebugFlag | Yes | No |
| 160 | shortcutFlag | Yes | No |
| 161 | probeSeconds | Yes | No |
| 162 | probeKillSeconds | Yes | No |
| 163 | probeInterval | Yes | No |
| 164 | lossyColumns | Yes | No |
| 165 | fPrecision | Yes | No |
| 166 | dPrecision | Yes | No |
| 167 | maxRange | Yes | No |
| 168 | range | Yes | No |