index.md 37.8 KB
Newer Older
1 2
---
title: Configuration Parameters
D
danielclow 已提交
3
description: This document describes the configuration parameters for the TDengine server and client.
4 5 6 7 8 9
---

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

32
## Configuration Parameters
33

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/) |
86
| TCP      | 6043         | Service Port of taosKeeper                       | The parameter of taosKeeper |
D
danielclow 已提交
87 88 89
| 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

102 103 104
:::note
Please note the `taoskeeper` needs to be installed and running to create the `log` database and receiving metrics sent by `taosd` as the full monitoring solution.

D
danielclow 已提交
105
### monitor
106

D
danielclow 已提交
107 108 109 110 111
| 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                                                                                                                                                                |
112
| Default   | 0                                                                                                                                                                                                  |
113

D
danielclow 已提交
114
### monitorFqdn
115

D
danielclow 已提交
116 117 118 119 120
| Attribute     | Description                                                    |
| -------- | -------------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | FQDN of taosKeeper monitoring service |
| Default   | None                                                                                    |
121

D
danielclow 已提交
122
### monitorPort
123

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

### monitorInterval

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

### telemetryReporting

D
danielclow 已提交
142 143 144
| Attribute     | Description                                                                                                                                                                         |
| -------- | ---------------------------------------- |
| Applicable    | Server Only                                                                                                                                                                         |
145 146
| Meaning       | Switch for allowing TDengine to collect and report service usage information |
| Value Range   | 0: Not allowed; 1: Allowed                                                   |
D
danielclow 已提交
147
| Default Value | 1                                                                                                                                                                                   |
W
wade zhang 已提交
148 149 150 151 152 153 154 155 156
### 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                                           |

157 158 159

## Query Parameters

D
danielclow 已提交
160
### queryPolicy
161

D
danielclow 已提交
162 163 164 165 166 167
| Attribute     | Description                          |
| -------- | ----------------------------- |
| Applicable | Client only                                           |
| Meaning     | Execution policy for query statements            |
| Unit     | None                            |
| Default   | 1                             |
W
wade zhang 已提交
168
| Value Range | 1: Run queries on vnodes and not on qnodes; 2: Run subtasks without scan operators on qnodes and subtasks with scan operators on vnodes; 3: Only run scan operators on vnodes, and run all other operators on qnodes. |
D
danielclow 已提交
169 170 171 172 173 174

### querySmaOptimize

| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable | Client only                                           |
175
| Meaning  | SMA index optimization policy |
D
danielclow 已提交
176 177
| Unit     | None                            |
| Default Value | 0                                                 |
W
wade zhang 已提交
178
| 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.|
179

180 181 182 183 184
### countAlwaysReturnValue 

| Attribute     | Description                             |
| -------- | -------------------------------- |
| Applicable | Server only                     |
G
Ganlin Zhao 已提交
185
| Meaning   | count()/hyperloglog() return value or not if the input data is empty or NULL |
186 187
| Vlue Range | 0:Return empty line,1:Return 0       |
| Default   | 1                            |
G
Ganlin Zhao 已提交
188
| Notes | When this parameter is setting to 1, for queries containing GROUP BY, PARTITION BY and INTERVAL clause, and input data in certain groups or windows is empty or NULL, the corresponding groups or windows have no return values |
189 190 191

### maxNumOfDistinctRes

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

199 200 201 202 203 204 205 206 207
### 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                            |

208 209 210 211
## Locale Parameters

### timezone

D
danielclow 已提交
212 213 214
| Attribute     | Description                                                                                                                                                                         |
| -------- | ------------------------------ |
| Applicable    | Server and Client                                                                                                      |
215 216 217 218
| Meaning       | TimeZone                        |
| Default Value | TimeZone configured in the host |

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

wafwerar's avatar
wafwerar 已提交
221
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:
222 223

```
D
danielclow 已提交
224
timezone UTC-8
225 226 227 228 229 230
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`.

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

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

249
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.
250 251 252 253 254 255 256 257 258 259 260 261

:::

### locale

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

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

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

wafwerar's avatar
wafwerar 已提交
266
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.
267 268 269 270 271 272 273 274 275 276 277 278

:::

### charset

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

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

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

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

D
danielclow 已提交
287 288 289 290 291 292 293 294
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 已提交
295
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.
296

D
danielclow 已提交
297
```
298 299 300 301
locale zh_CN.UTF-8
charset GBK
```

D
danielclow 已提交
302 303 304
The charset that takes effect is GBK.

```
305 306 307 308
charset GBK
locale zh_CN.UTF-8
```

D
danielclow 已提交
309
The charset that takes effect is UTF-8.
310 311 312 313 314 315 316

:::

## Storage Parameters

### dataDir

D
danielclow 已提交
317 318
| Attribute     | Description               |
| -------- | ------------------------------------------ |
319 320 321
| Applicable    | Server Only                                 |
| Meaning       | All data files are stored in this directory |
| Default Value | /var/lib/taos                               |
C
Cary Xu 已提交
322
| 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 |
323

324 325 326 327 328 329 330 331
### tempDir

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

332 333
### minimalTmpDirGB

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

### minimalDataDirGB

D
danielclow 已提交
343 344 345 346 347 348
| 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                                                                   |
349 350 351

## Cluster Parameters

D
danielclow 已提交
352
### supportVnodes
353

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

## Log Parameters

### logDir

D
danielclow 已提交
365 366 367
| Attribute     | Description                            |
| -------- | -------------------------------------------------- |
| Applicable    | Server and Client         |
368 369 370 371 372
| Meaning       | The directory for writing log files |
| Default Value | /var/log/taos                       |

### minimalLogDirGB

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

### numOfLogLines

D
danielclow 已提交
382 383 384
| Attribute     | Description                            |
| -------- | ---------------------------- |
| Applicable    | Server and Client         |
385
| Meaning       | Maximum number of lines in single log file |
D
danielclow 已提交
386
| Default Value | 10000000                            |
387 388 389

### asyncLog

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

### logKeepDays

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

D
danielclow 已提交
418 419 420 421
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server and Client         |
| Meaning       | Log level of timer module |
422
| Value Range   | same as debugFlag  |
D
danielclow 已提交
423
| Default Value | |
424

D
danielclow 已提交
425
### uDebugFlag
426

D
danielclow 已提交
427 428 429 430
| Attribute     | Description                            |
| -------- | ---------------------- |
| Applicable    | Server and Client         |
| Meaning       | Log level of common module |
431
| Value Range   | same as debugFlag  |
D
danielclow 已提交
432
| Default Value | |
433 434 435

### rpcDebugFlag

D
danielclow 已提交
436 437 438
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server and Client         |
439
| Meaning       | Log level of rpc module |
D
danielclow 已提交
440 441
| Value Range   | same as debugFlag  |
| Default Value | |
442

D
danielclow 已提交
443
### jniDebugFlag
444

D
danielclow 已提交
445 446 447 448 449 450 451 452 453 454 455
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Client Only         |
| Meaning       | Log level of jni module |
| Value Range   | same as debugFlag  |
| Default Value | |

### qDebugFlag

| Attribute     | Description                            |
| -------- | -------------------- |
456
| Applicable    | Server and Client         |
D
danielclow 已提交
457 458 459
| Meaning     | Log level of query module |
| Value Range   | same as debugFlag  |
| Default Value | |
460 461 462

### cDebugFlag

D
danielclow 已提交
463 464
| Attribute     | Description                            |
| -------- | --------------------- |
465 466
| Applicable    | Client Only         |
| Meaning       | Log level of Client |
D
danielclow 已提交
467 468
| Value Range   | same as debugFlag  |
| Default Value | |
469

D
danielclow 已提交
470
### dDebugFlag
471

D
danielclow 已提交
472 473 474 475 476 477
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning       | Log level of dnode |
| Value Range   | same as debugFlag  |
| Default Value | 135                              |
478

D
danielclow 已提交
479
### vDebugFlag
480

D
danielclow 已提交
481 482 483 484 485 486
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning       | Log level of vnode |
| Value Range   | same as debugFlag  |
| Default Value | |
487

D
danielclow 已提交
488
### mDebugFlag
489

D
danielclow 已提交
490 491 492 493 494 495
| Attribute     | Description                            |
| -------- | -------------------- |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of mnode module |
| Value Range   | same as debugFlag  |
| Default Value | 135                              |
496

D
danielclow 已提交
497
### wDebugFlag
498

D
danielclow 已提交
499 500 501 502 503 504
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of WAL module |
| Value Range   | same as debugFlag  |
| Default Value | 135                          |
505

D
danielclow 已提交
506
### sDebugFlag
507

D
danielclow 已提交
508 509
| Attribute     | Description                            |
| -------- | -------------------- |
510
| Applicable    | Server and Client         |
D
danielclow 已提交
511 512 513
| Meaning       | Log level of sync module |
| Value Range   | same as debugFlag  |
| Default Value | 135                              |
514 515 516

### tsdbDebugFlag

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

D
danielclow 已提交
524
### tqDebugFlag
525 526

| Attribute     | Description                          |
D
danielclow 已提交
527 528 529 530 531
| -------- | ----------------- |
| Applicable | Server only                                           |
| Meaning     | Log level of TQ module |
| Value Range   | same as debugFlag  |
| Default Value | |
532

D
danielclow 已提交
533
### fsDebugFlag
534

D
danielclow 已提交
535 536 537 538 539 540 541 542
| Attribute     | Description                          |
| -------- | ----------------- |
| Applicable | Server only                                           |
| Meaning     | Log level of FS module |
| Value Range   | same as debugFlag  |
| Default Value | |

### udfDebugFlag
543 544

| Attribute     | Description                            |
D
danielclow 已提交
545 546 547 548 549
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning       | Log level of UDF module |
| Value Range   | same as debugFlag  |
| Default Value | |
550

D
danielclow 已提交
551
### smaDebugFlag
552

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

D
danielclow 已提交
560
### idxDebugFlag
561

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

D
danielclow 已提交
569
### tdbDebugFlag
570

D
danielclow 已提交
571 572 573 574 575 576
| Attribute     | Description                            |
| -------- | ------------------ |
| Applicable    | Server Only                                                    |
| Meaning     | Log level of TDB module |
| Value Range   | same as debugFlag  |
| Default Value | |
577

D
danielclow 已提交
578
## Schemaless Parameters
579

D
danielclow 已提交
580
### smlChildTableName
581

D
danielclow 已提交
582 583 584 585 586 587
| Attribute     | Description                      |
| -------- | ------------------------- |
| Applicable | Client only                                           |
| Meaning     | Custom subtable name for schemaless writes |
| Type     | String                    |
| Default Value   | None                        |
588

D
danielclow 已提交
589
### smlTagName
590

D
danielclow 已提交
591 592 593 594 595 596 597 598
| Attribute     | Description                            |
| -------- | ------------------------------------ |
| Applicable | Client only                                           |
| Meaning     | Default tag for schemaless writes without tag value specified |
| Type     | String                    |
| Default Value   | _tag_null                                 |

### smlDataFormat
599 600

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

G
gccgdb1234 已提交
607 608 609 610 611 612
## Compress Parameters

### compressMsgSize

| Attribute     | Description                          |
| -------- | ----------------------------- |
G
gccgdb1234 已提交
613
| Applicable | Both Client and Server side                                           |
G
gccgdb1234 已提交
614 615 616 617 618
| 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                           |


619 620 621 622
## Other Parameters

### enableCoreFile

D
danielclow 已提交
623 624
| Attribute     | Description                                                                                         |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
625 626 627 628
| 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 已提交
629
| 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 已提交
630

A
Alex Duan 已提交
631 632 633 634 635 636 637 638 639 640
### enableScience

| Attribute     | Description                                                                                         |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Applicable    |  Only taos-CLI client                                                                                                                                                      |
| Meaning       | Whether to show float and double with the scientific notation                                                |
| Value Range   | 0: false, 1: true                                                                                                                                                       |
| Default Value | 0                                                                                                                                                                       |


D
danielclow 已提交
641 642 643 644 645 646 647 648 649
### udf

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

650 651 652

## 3.0 Parameters

653
| #   |        **参数**         | **Applicable to 2.x ** | **Applicable to  3.0 ** | Current behavior in 3.0             |
654
| --- | :---------------------: | --------------- | --------------- | ------------------------------------------------- |
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
| 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 已提交
675
| 23  |      smlDataFormat      | No              | Yes(discarded since 3.0.3.0)              |                                                   |
676 677 678 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
| 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              |                                                   |