index.md 36.4 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                                                                                                                                                                                   |
W
wade zhang 已提交
145 146 147 148 149 150 151 152 153
### crashReporting

| Attribute     | Description                                        |
| -------- | -------------------------------------------- |
| Applicable | Server Only                                 |
| Meaning     |Switch for allowing TDengine to collect and report crash related information |
| Value Range | 0,1   0: Not allowed;1:allowed                                 |
| Default Value   | 1                                           |

154 155 156

## Query Parameters

D
danielclow 已提交
157
### queryPolicy
158

D
danielclow 已提交
159 160 161 162 163 164
| Attribute     | Description                          |
| -------- | ----------------------------- |
| Applicable | Client only                                           |
| Meaning     | Execution policy for query statements            |
| Unit     | None                            |
| Default   | 1                             |
C
cadem 已提交
165
| Value Range | 1: Run queries on vnodes and not on qnodes<br>2: Run subtasks without scan operators on qnodes and subtasks with scan operators on vnodes.<br>3: Only run scan operators on vnodes; run all other operators on qnodes. |
D
danielclow 已提交
166 167 168 169 170 171

### querySmaOptimize

| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable | Client only                                           |
172
| Meaning  | SMA index optimization policy |
D
danielclow 已提交
173 174
| Unit     | None                            |
| Default Value | 0                                                 |
C
cadem 已提交
175
| Notes |0: Disable SMA indexing and perform all queries on non-indexed data.<br>1: Enable SMA indexing and perform queries from suitable statements on precomputation results.|
176

177 178 179 180 181 182 183 184
### countAlwaysReturnValue 

| Attribute     | Description                             |
| -------- | -------------------------------- |
| Applicable | Server only                     |
| Meaning   | count()/hyperloglog() return value or not if the result data is NULL |
| Vlue Range | 0:Return empty line,1:Return 0       |
| Default   | 1                            |
185 186 187

### maxNumOfDistinctRes

D
danielclow 已提交
188
| Attribute     | Description                                                                                                                                                                         |
189
| -------- | -------------------------------- |
D
danielclow 已提交
190
| Applicable    | Server Only                                                                                                                                                                         |
191
| Meaning       | The maximum number of distinct rows returned |
S
Sean Ely 已提交
192 193
| Value Range   | [100,000 - 100,000,000]                      |
| Default Value | 100,000                                      |
194

195 196 197 198 199 200 201 202 203
### 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                            |

204 205 206 207
## Locale Parameters

### timezone

D
danielclow 已提交
208 209 210
| Attribute     | Description                                                                                                                                                                         |
| -------- | ------------------------------ |
| Applicable    | Server and Client                                                                                                      |
211 212 213 214
| Meaning       | TimeZone                        |
| Default Value | TimeZone configured in the host |

:::info
D
danielclow 已提交
215
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.
216

wafwerar's avatar
wafwerar 已提交
217
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:
218 219

```
D
danielclow 已提交
220
timezone UTC-8
221 222 223 224 225 226
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`.

227
The setting for timezone impacts strings that are not in Unix timestamp format and keywords or functions related to date/time. For example:
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244

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

245
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.
246 247 248 249 250 251 252 253 254 255 256 257

:::

### locale

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

:::info
D
danielclow 已提交
258
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.
259

wafwerar's avatar
wafwerar 已提交
260
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.
261

wafwerar's avatar
wafwerar 已提交
262
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.
263 264 265 266 267 268 269 270 271 272 273 274

:::

### charset

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

:::info
wafwerar's avatar
wafwerar 已提交
275
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 已提交
276

wafwerar's avatar
wafwerar 已提交
277
So on Linux/macOS, if system locale is set properly, it's not necessary to set `charset` in `taos.cfg`. For example:
278 279 280 281 282

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

D
danielclow 已提交
283 284 285 286 287 288 289 290
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 已提交
291
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.
292

D
danielclow 已提交
293
```
294 295 296 297
locale zh_CN.UTF-8
charset GBK
```

D
danielclow 已提交
298 299 300
The charset that takes effect is GBK.

```
301 302 303 304
charset GBK
locale zh_CN.UTF-8
```

D
danielclow 已提交
305
The charset that takes effect is UTF-8.
306 307 308 309 310 311 312

:::

## Storage Parameters

### dataDir

D
danielclow 已提交
313 314
| Attribute     | Description               |
| -------- | ------------------------------------------ |
315 316 317
| Applicable    | Server Only                                 |
| Meaning       | All data files are stored in this directory |
| Default Value | /var/lib/taos                               |
C
Cary Xu 已提交
318
| Note          | The [Tiered Storage](https://docs.tdengine.com/tdinternal/arch/#tiered-storage) function needs to be used in conjunction with the [KEEP](https://docs.tdengine.com/taos-sql/database/#parameters) parameter |
319

320 321 322 323 324 325 326 327
### tempDir

| Attribute    | Description                                     |
| -------- | ------------------------------------------ |
| Applicable | Server only                               |
| Meaning     | The directory where to put all the temporary files generated during system running |
| Default   | /tmp                           |

328 329
### minimalTmpDirGB

D
danielclow 已提交
330 331 332
| Attribute     | Description                            |
| -------- | ------------------------------------------------ |
| Applicable    | Server and Client         |
333
| Meaning       | When the available disk space in tmpDir is below this threshold, writing to tmpDir is suspended |
D
danielclow 已提交
334 335
| Unit          | GB                            |
| Default Value | 1.0                                                                   |
336 337 338

### minimalDataDirGB

D
danielclow 已提交
339 340 341 342 343 344
| 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                                                                   |
345 346 347

## Cluster Parameters

D
danielclow 已提交
348
### supportVnodes
349

D
danielclow 已提交
350 351 352 353 354
| Attribute     | Description                            |
| -------- | --------------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | Maximum number of vnodes per dnode |
| Value Range | 0-4096                                     |
355
| Default Value | 2x the CPU cores                                                    |
356 357 358 359 360

## Log Parameters

### logDir

D
danielclow 已提交
361 362 363
| Attribute     | Description                            |
| -------- | -------------------------------------------------- |
| Applicable    | Server and Client         |
364 365 366 367 368
| Meaning       | The directory for writing log files |
| Default Value | /var/log/taos                       |

### minimalLogDirGB

D
danielclow 已提交
369 370 371
| Attribute     | Description                                                                                                                                                                         |
| -------- | -------------------------------------------- |
| Applicable    | Server and Client         |
372
| Meaning       | When the available disk space in logDir is below this threshold, writing to log files is suspended |
D
danielclow 已提交
373 374
| Unit          | GB                            |
| Default Value | 1.0                              |
375 376 377

### numOfLogLines

D
danielclow 已提交
378 379 380
| Attribute     | Description                            |
| -------- | ---------------------------- |
| Applicable    | Server and Client         |
381
| Meaning       | Maximum number of lines in single log file |
D
danielclow 已提交
382
| Default Value | 10000000                            |
383 384 385

### asyncLog

D
danielclow 已提交
386 387 388
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server and Client         |
389 390
| Meaning       | The mode of writing log file |
| Value Range   | 0: sync way; 1: async way    |
D
danielclow 已提交
391
| Default Value | 1                                                 |
392 393 394

### logKeepDays

D
danielclow 已提交
395 396 397
| Attribute     | Description                            |
| -------- | ----------------------------------------------------------------------------------- |
| Applicable    | Server and Client         |
398
| Meaning       | The number of days for log files to be kept                                                                                                 |
D
danielclow 已提交
399 400
| Unit          | day                                                   |
| Default Value | 0                                                               |
401 402 403 404
| 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 已提交
405 406 407
| Attribute     | Description                            |
| -------- | ------------------------------------------------------------------------------------------------- |
| Applicable    | Server and Client         |
408 409 410 411
| 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 已提交
412
### tmrDebugFlag
413

D
danielclow 已提交
414 415 416 417
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server and Client         |
| Meaning       | Log level of timer module |
418
| Value Range   | same as debugFlag  |
D
danielclow 已提交
419
| Default Value | |
420

D
danielclow 已提交
421
### uDebugFlag
422

D
danielclow 已提交
423 424 425 426
| Attribute     | Description                            |
| -------- | ---------------------- |
| Applicable    | Server and Client         |
| Meaning       | Log level of common module |
427
| Value Range   | same as debugFlag  |
D
danielclow 已提交
428
| Default Value | |
429 430 431

### rpcDebugFlag

D
danielclow 已提交
432 433 434
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server and Client         |
435
| Meaning       | Log level of rpc module |
D
danielclow 已提交
436 437
| Value Range   | same as debugFlag  |
| Default Value | |
438

D
danielclow 已提交
439
### jniDebugFlag
440

D
danielclow 已提交
441 442 443 444 445 446 447 448 449 450 451
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Client Only         |
| Meaning       | Log level of jni module |
| Value Range   | same as debugFlag  |
| Default Value | |

### qDebugFlag

| Attribute     | Description                            |
| -------- | -------------------- |
452
| Applicable    | Server and Client         |
D
danielclow 已提交
453 454 455
| Meaning     | Log level of query module |
| Value Range   | same as debugFlag  |
| Default Value | |
456 457 458

### cDebugFlag

D
danielclow 已提交
459 460
| Attribute     | Description                            |
| -------- | --------------------- |
461 462
| Applicable    | Client Only         |
| Meaning       | Log level of Client |
D
danielclow 已提交
463 464
| Value Range   | same as debugFlag  |
| Default Value | |
465

D
danielclow 已提交
466
### dDebugFlag
467

D
danielclow 已提交
468 469 470 471 472 473
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning       | Log level of dnode |
| Value Range   | same as debugFlag  |
| Default Value | 135                              |
474

D
danielclow 已提交
475
### vDebugFlag
476

D
danielclow 已提交
477 478 479 480 481 482
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning       | Log level of vnode |
| Value Range   | same as debugFlag  |
| Default Value | |
483

D
danielclow 已提交
484
### mDebugFlag
485

D
danielclow 已提交
486 487 488 489 490 491
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of mnode module |
| Value Range   | same as debugFlag  |
| Default Value | 135                              |
492

D
danielclow 已提交
493
### wDebugFlag
494

D
danielclow 已提交
495 496 497 498 499 500
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of WAL module |
| Value Range   | same as debugFlag  |
| Default Value | 135                          |
501

D
danielclow 已提交
502
### sDebugFlag
503

D
danielclow 已提交
504 505
| Attribute     | Description                            |
| -------- | -------------------- |
506
| Applicable    | Server and Client         |
D
danielclow 已提交
507 508 509
| Meaning       | Log level of sync module |
| Value Range   | same as debugFlag  |
| Default Value | 135                              |
510 511 512

### tsdbDebugFlag

D
danielclow 已提交
513 514 515 516 517 518
| Attribute     | Description                            |
| -------- | ------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of TSDB module |
| Value Range   | same as debugFlag  |
| Default Value | |
519

D
danielclow 已提交
520
### tqDebugFlag
521 522

| Attribute     | Description                          |
D
danielclow 已提交
523 524 525 526 527
| -------- | ----------------- |
| Applicable | Server only                                           |
| Meaning     | Log level of TQ module |
| Value Range   | same as debugFlag  |
| Default Value | |
528

D
danielclow 已提交
529
### fsDebugFlag
530

D
danielclow 已提交
531 532 533 534 535 536 537 538
| Attribute     | Description                          |
| -------- | ----------------- |
| Applicable | Server only                                           |
| Meaning     | Log level of FS module |
| Value Range   | same as debugFlag  |
| Default Value | |

### udfDebugFlag
539 540

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

D
danielclow 已提交
547
### smaDebugFlag
548

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

D
danielclow 已提交
556
### idxDebugFlag
557

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

D
danielclow 已提交
565
### tdbDebugFlag
566

D
danielclow 已提交
567 568 569 570 571 572
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of TDB module |
| Value Range   | same as debugFlag  |
| Default Value | |
573

D
danielclow 已提交
574
## Schemaless Parameters
575

D
danielclow 已提交
576
### smlChildTableName
577

D
danielclow 已提交
578 579 580 581 582 583
| Attribute     | Description                      |
| -------- | ------------------------- |
| Applicable | Client only                                           |
| Meaning     | Custom subtable name for schemaless writes |
| Type     | String                    |
| Default Value   | None                        |
584

D
danielclow 已提交
585
### smlTagName
586

D
danielclow 已提交
587 588 589 590 591 592 593 594
| Attribute     | Description                            |
| -------- | ------------------------------------ |
| Applicable | Client only                                           |
| Meaning     | Default tag for schemaless writes without tag value specified |
| Type     | String                    |
| Default Value   | _tag_null                                 |

### smlDataFormat
595 596

| Attribute     | Description                          |
D
danielclow 已提交
597 598
| -------- | ----------------------------- |
| Applicable | Client only                                           |
wmmhello's avatar
wmmhello 已提交
599
| Meaning     | Whether schemaless columns are consistently ordered, depat, discarded since 3.0.3.0|
D
danielclow 已提交
600 601
| Value Range     | 0: not consistent; 1: consistent.            |
| Default   | 1                             |
602

G
gccgdb1234 已提交
603 604 605 606 607 608
## Compress Parameters

### compressMsgSize

| Attribute     | Description                          |
| -------- | ----------------------------- |
G
gccgdb1234 已提交
609
| Applicable | Both Client and Server side                                           |
G
gccgdb1234 已提交
610 611 612 613 614
| Meaning     | Whether RPC message is compressed |
| Value Range     | -1: none message is compressed; 0: all messages are compressed; N (N>0): messages exceeding N bytes are compressed        |
| Default   | -1                           |


615 616 617 618
## Other Parameters

### enableCoreFile

D
danielclow 已提交
619 620
| Attribute     | Description                                                                                         |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
621 622 623 624
| 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 已提交
625
| 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 已提交
626 627 628 629 630 631 632 633 634 635

### udf

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

636 637 638

## 3.0 Parameters

639
| #   |        **参数**         | **Applicable to 2.x ** | **Applicable to  3.0 ** | Current behavior in 3.0             |
640
| --- | :---------------------: | --------------- | --------------- | ------------------------------------------------- |
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
| 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  |       queryPolicy       | No              | Yes              |                                                   |
| 11  |    querySmaOptimize     | No              | Yes              |                                                   |
| 12  |   maxNumOfDistinctRes   | Yes              | Yes              |                                                   |
| 15  | countAlwaysReturnValue  | Yes              | Yes              |                                                   |
| 16  |         dataDir         | Yes              | Yes              |                                                   |
| 17  |    minimalDataDirGB     | Yes              | Yes              |                                                   |
| 18  |      supportVnodes      | No              | Yes              |                                                   |
| 19  |         tempDir         | Yes              | Yes              |                                                   |
| 20  |     minimalTmpDirGB     | Yes              | Yes              |                                                   |
| 21  |    smlChildTableName    | Yes              | Yes              |                                                   |
| 22  |       smlTagName        | Yes              | Yes              |                                                   |
wmmhello's avatar
wmmhello 已提交
661
| 23  |      smlDataFormat      | No              | Yes(discarded since 3.0.3.0)              |                                                   |
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
| 24  |     statusInterval      | Yes              | Yes              |                                                   |
| 25  |         logDir          | Yes              | Yes              |                                                   |
| 26  |     minimalLogDirGB     | Yes              | Yes              |                                                   |
| 27  |      numOfLogLines      | Yes              | Yes              |                                                   |
| 28  |        asyncLog         | Yes              | Yes              |                                                   |
| 29  |       logKeepDays       | Yes              | Yes              |                                                   |
| 30  |        debugFlag        | Yes              | Yes              |                                                   |
| 31  |      tmrDebugFlag       | Yes              | Yes              |                                                   |
| 32  |       uDebugFlag        | Yes              | Yes              |                                                   |
| 33  |      rpcDebugFlag       | Yes              | Yes              |                                                   |
| 34  |      jniDebugFlag       | Yes              | Yes              |                                                   |
| 35  |       qDebugFlag        | Yes              | Yes              |                                                   |
| 36  |       cDebugFlag        | Yes              | Yes              |                                                   |
| 37  |       dDebugFlag        | Yes              | Yes              |                                                   |
| 38  |       vDebugFlag        | Yes              | Yes              |                                                   |
| 39  |       mDebugFlag        | Yes              | Yes              |                                                   |
| 40  |       wDebugFlag        | Yes              | Yes              |                                                   |
| 41  |       sDebugFlag        | Yes              | Yes              |                                                   |
| 42  |      tsdbDebugFlag      | Yes              | Yes              |                                                   |
| 43  |       tqDebugFlag       | No              | Yes              |                                                   |
| 44  |       fsDebugFlag       | Yes              | Yes              |                                                   |
| 45  |      udfDebugFlag       | No              | Yes              |                                                   |
| 46  |      smaDebugFlag       | No              | Yes              |                                                   |
| 47  |      idxDebugFlag       | No              | Yes              |                                                   |
| 48  |      tdbDebugFlag       | No              | Yes              |                                                   |
| 49  |      metaDebugFlag      | No              | Yes              |                                                   |
| 50  |        timezone         | Yes              | Yes              |                                                   |
| 51  |         locale          | Yes              | Yes              |                                                   |
| 52  |         charset         | Yes              | Yes              |                                                   |
| 53  |           udf           | Yes              | Yes              |                                                   |
| 54  |     enableCoreFile      | Yes              | Yes              |                                                   |