index.md 47.0 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
---

## Configuration File on Server Side

8
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` on Linux system, it's located under `C:\TDengine` on Windows system. The location of configuration file can be specified by using `-c` parameter on the CLI of `taosd`. For example, on Linux system the configuration file can be put under `/home/user` and used like below
9

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

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

### secondEp

dengyihao's avatar
dengyihao 已提交
56 57 58 59 60
| Attribute  | Description                                                                                                            |
| ---------- | ---------------------------------------------------------------------------------------------------------------------- |
| Applicable | Server and Client                                                                                                      |
| Meaning    | The end point of the second dnode to be connected to if the firstEp is not available when `taosd` or `taos` is started |
| 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 |
dengyihao's avatar
dengyihao 已提交
68 69
| Default Value | The first hostname configured for the host                               |
| Note          | It should be within 96 bytes                                             |  |
70 71 72

### serverPort

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

:::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
:::
dengyihao's avatar
dengyihao 已提交
82 83 84 85 86 87 88 89
| Protocol | Default Port | Description                                                                                               | How to configure                                                                               |
| :------- | :----------- | :-------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------- |
| TCP      | 6030         | Communication between client and server. In a multi-node cluster, communication between nodes. serverPort |
| 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/) |
| 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                                                 |

dengyihao's avatar
dengyihao 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112 113
### numOfRpcSessions 

| Attribute     | Description                                |
| ------------- | ------------------------------------------ |
| Applicable    | Client/Server                              |
| Meaning       | The maximum number of connection to create |
| Value Range   | 100-100000                                 |
| Default Value | 10000                                      |

### timeToGetAvailableConn

| Attribute     | Description                                    |
| ------------- | ---------------------------------------------- |
| Applicable    | Client/Server                                  |
sangshuduo's avatar
sangshuduo 已提交
114
| Meaning       | The maximum waiting time to get available conn |
dengyihao's avatar
dengyihao 已提交
115 116 117
| Value Range   | 10-50000000(ms)                                |
| Default Value | 500000                                         |

D
danielclow 已提交
118
## Monitoring Parameters
119

120 121 122
:::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 已提交
123
### monitor
124

dengyihao's avatar
dengyihao 已提交
125 126 127 128 129 130
| 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                                                                                                                                                                                                                                                                         |
| Default     | 0                                                                                                                                                                                                                                                                                                                     |
131

D
danielclow 已提交
132
### monitorFqdn
133

dengyihao's avatar
dengyihao 已提交
134 135 136 137 138
| Attribute  | Description                           |
| ---------- | ------------------------------------- |
| Applicable | Server Only                           |
| Meaning    | FQDN of taosKeeper monitoring service |
| Default    | None                                  |
139

D
danielclow 已提交
140
### monitorPort
141

dengyihao's avatar
dengyihao 已提交
142 143 144 145 146
| Attribute     | Description                           |
| ------------- | ------------------------------------- |
| Applicable    | Server Only                           |
| Meaning       | Port of taosKeeper monitoring service |
| Default Value | 6043                                  |
147 148 149

### monitorInterval

dengyihao's avatar
dengyihao 已提交
150 151 152
| Attribute     | Description                                |
| ------------- | ------------------------------------------ |
| Applicable    | Server Only                                |
153 154
| Meaning       | The interval of collecting system workload |
| Unit          | second                                     |
dengyihao's avatar
dengyihao 已提交
155 156
| Value Range   | 1-200000                                   |
| Default Value | 30                                         |
157 158 159

### telemetryReporting

dengyihao's avatar
dengyihao 已提交
160 161 162
| Attribute     | Description                                                                  |
| ------------- | ---------------------------------------------------------------------------- |
| Applicable    | Server Only                                                                  |
163 164
| Meaning       | Switch for allowing TDengine to collect and report service usage information |
| Value Range   | 0: Not allowed; 1: Allowed                                                   |
dengyihao's avatar
dengyihao 已提交
165
| Default Value | 1                                                                            |
W
wade zhang 已提交
166 167
### crashReporting

dengyihao's avatar
dengyihao 已提交
168 169 170 171 172 173
| 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                                                                            |
W
wade zhang 已提交
174

175 176 177

## Query Parameters

D
danielclow 已提交
178
### queryPolicy
179

dengyihao's avatar
dengyihao 已提交
180 181 182 183 184 185
| Attribute   | Description                                                                                                                                                                                                           |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Applicable  | Client only                                                                                                                                                                                                           |
| Meaning     | Execution policy for query statements                                                                                                                                                                                 |
| Unit        | None                                                                                                                                                                                                                  |
| Default     | 1                                                                                                                                                                                                                     |
W
wade zhang 已提交
186
| 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 已提交
187 188 189

### querySmaOptimize

dengyihao's avatar
dengyihao 已提交
190 191 192 193 194 195 196
| Attribute     | Description                                                                                                                                                         |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Applicable    | Client only                                                                                                                                                         |
| Meaning       | SMA index optimization policy                                                                                                                                       |
| 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. |
197

198 199
### countAlwaysReturnValue 

dengyihao's avatar
dengyihao 已提交
200 201 202 203 204 205 206
| Attribute  | Description                                                                                                                                                                                                                     |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Applicable | Server only                                                                                                                                                                                                                     |
| Meaning    | count()/hyperloglog() return value or not if the input data is empty or NULL                                                                                                                                                    |
| Vlue Range | 0: Return empty line, 1: Return 0                                                                                                                                                                                               |
| Default    | 1                                                                                                                                                                                                                               |
| 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 |
207 208 209

### maxNumOfDistinctRes

dengyihao's avatar
dengyihao 已提交
210 211 212
| Attribute     | Description                                  |
| ------------- | -------------------------------------------- |
| Applicable    | Server Only                                  |
213
| Meaning       | The maximum number of distinct rows returned |
S
Sean Ely 已提交
214 215
| Value Range   | [100,000 - 100,000,000]                      |
| Default Value | 100,000                                      |
216

217 218
### keepColumnName

dengyihao's avatar
dengyihao 已提交
219 220 221 222 223 224
| 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                                                                                                               |
225

226 227 228 229
## Locale Parameters

### timezone

dengyihao's avatar
dengyihao 已提交
230 231 232
| Attribute     | Description                     |
| ------------- | ------------------------------- |
| Applicable    | Server and Client               |
233 234 235 236
| Meaning       | TimeZone                        |
| Default Value | TimeZone configured in the host |

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

wafwerar's avatar
wafwerar 已提交
239
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:
240 241

```
D
danielclow 已提交
242
timezone UTC-8
243 244 245 246 247 248
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`.

249
The setting for timezone impacts strings that are not in Unix timestamp format and keywords or functions related to date/time. For example:
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266

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

267
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.
268 269 270 271 272 273 274 275 276 277 278 279

:::

### locale

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

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

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

wafwerar's avatar
wafwerar 已提交
284
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.
285 286 287 288 289 290 291 292 293 294 295 296

:::

### charset

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

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

wafwerar's avatar
wafwerar 已提交
299
So on Linux/macOS, if system locale is set properly, it's not necessary to set `charset` in `taos.cfg`. For example:
300 301 302 303 304

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

D
danielclow 已提交
305 306 307 308 309 310 311 312
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 已提交
313
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.
314

D
danielclow 已提交
315
```
316 317 318 319
locale zh_CN.UTF-8
charset GBK
```

D
danielclow 已提交
320 321 322
The charset that takes effect is GBK.

```
323 324 325 326
charset GBK
locale zh_CN.UTF-8
```

D
danielclow 已提交
327
The charset that takes effect is UTF-8.
328 329 330 331 332 333 334

:::

## Storage Parameters

### dataDir

dengyihao's avatar
dengyihao 已提交
335 336 337 338 339
| Attribute     | Description                                                                                                                                                                                                 |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Applicable    | Server Only                                                                                                                                                                                                 |
| Meaning       | All data files are stored in this directory                                                                                                                                                                 |
| Default Value | /var/lib/taos                                                                                                                                                                                               |
C
Cary Xu 已提交
340
| 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 |
341

342 343
### tempDir

dengyihao's avatar
dengyihao 已提交
344 345 346 347 348
| Attribute  | Description                                                                        |
| ---------- | ---------------------------------------------------------------------------------- |
| Applicable | Server only                                                                        |
| Meaning    | The directory where to put all the temporary files generated during system running |
| Default    | /tmp                                                                               |
349

350 351
### minimalTmpDirGB

dengyihao's avatar
dengyihao 已提交
352 353 354
| Attribute     | Description                                                                                     |
| ------------- | ----------------------------------------------------------------------------------------------- |
| Applicable    | Server and Client                                                                               |
355
| Meaning       | When the available disk space in tmpDir is below this threshold, writing to tmpDir is suspended |
dengyihao's avatar
dengyihao 已提交
356 357
| Unit          | GB                                                                                              |
| Default Value | 1.0                                                                                             |
358 359 360

### minimalDataDirGB

dengyihao's avatar
dengyihao 已提交
361 362 363
| Attribute     | Description                                                                                       |
| ------------- | ------------------------------------------------------------------------------------------------- |
| Applicable    | Server Only                                                                                       |
D
danielclow 已提交
364
| Meaning       | When the available disk space in dataDir is below this threshold, writing to dataDir is suspended |
dengyihao's avatar
dengyihao 已提交
365 366
| Unit          | GB                                                                                                |
| Default Value | 2.0                                                                                               |
367

368 369 370 371 372 373 374 375 376 377
### metaCacheMaxSize

| Attribute     | Description                                                                                       |
| ------------- | ------------------------------------------------------------------------------------------------- |
| Applicable    | Client Only                                                                                       |
| Meaning       | Maximum meta cache size in single client process                                                  |
| Unit          | MB                                                                                                |
| Default Value | -1 (No limitation)                                                                                |


378 379
## Cluster Parameters

D
danielclow 已提交
380
### supportVnodes
381

dengyihao's avatar
dengyihao 已提交
382 383 384 385 386 387
| Attribute     | Description                        |
| ------------- | ---------------------------------- |
| Applicable    | Server Only                        |
| Meaning       | Maximum number of vnodes per dnode |
| Value Range   | 0-4096                             |
| Default Value | 2x the CPU cores                   |
388

389 390 391 392 393 394 395 396 397 398 399
## Performance Tuning

### numOfCommitThreads

| Attribute     | Description                         |
| ------------- | ----------------------------------- |
| Applicable    | Server Only                         |
| Meaning       | Maximum number of threads to commit |
| Value Range   | 0-1024                              |
| Default Value |                                     |

400 401 402 403
## Log Parameters

### logDir

dengyihao's avatar
dengyihao 已提交
404 405 406
| Attribute     | Description                         |
| ------------- | ----------------------------------- |
| Applicable    | Server and Client                   |
407 408 409 410 411
| Meaning       | The directory for writing log files |
| Default Value | /var/log/taos                       |

### minimalLogDirGB

dengyihao's avatar
dengyihao 已提交
412 413 414
| Attribute     | Description                                                                                        |
| ------------- | -------------------------------------------------------------------------------------------------- |
| Applicable    | Server and Client                                                                                  |
415
| Meaning       | When the available disk space in logDir is below this threshold, writing to log files is suspended |
dengyihao's avatar
dengyihao 已提交
416 417
| Unit          | GB                                                                                                 |
| Default Value | 1.0                                                                                                |
418 419 420

### numOfLogLines

dengyihao's avatar
dengyihao 已提交
421 422 423
| Attribute     | Description                                |
| ------------- | ------------------------------------------ |
| Applicable    | Server and Client                          |
424
| Meaning       | Maximum number of lines in single log file |
dengyihao's avatar
dengyihao 已提交
425
| Default Value | 10000000                                   |
426 427 428

### asyncLog

dengyihao's avatar
dengyihao 已提交
429 430 431
| Attribute     | Description                  |
| ------------- | ---------------------------- |
| Applicable    | Server and Client            |
432 433
| Meaning       | The mode of writing log file |
| Value Range   | 0: sync way; 1: async way    |
dengyihao's avatar
dengyihao 已提交
434
| Default Value | 1                            |
435 436 437

### logKeepDays

dengyihao's avatar
dengyihao 已提交
438 439 440
| Attribute     | Description                                                                                                                                 |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| Applicable    | Server and Client                                                                                                                           |
441
| Meaning       | The number of days for log files to be kept                                                                                                 |
dengyihao's avatar
dengyihao 已提交
442 443
| Unit          | day                                                                                                                                         |
| Default Value | 0                                                                                                                                           |
444 445
| 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 |

D
dapan1121 已提交
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
### slowLogThreshold

| Attribute     | Description                                                                                              |
| ------------- | -------------------------------------------------------------------------------------------------------- |
| Applicable    | Client only                                                                                              |
| Meaning       | When an operation execution time exceeds this threshold, the operation will be logged in slow log file   |
| Unit          | second                                                                                                   |
| Default Value | 3                                                                                                        |
| Note          | All slow operations will be logged in file "taosSlowLog" in the log directory                            |

### slowLogScope

| Attribute       | Description                                                             |
| --------------- | ----------------------------------------------------------------------- |
| Applicable      | Client only                                                             |
| Meaning         | Slow log type to be logged                                              |
| Optional Values | ALL, QUERY, INSERT, OTHERS, NONE                                        |
| Default Value   | ALL                                                                     |
| Note            | All slow operations will be logged by default, one option could be set  |

466 467
### debugFlag

dengyihao's avatar
dengyihao 已提交
468 469 470
| Attribute     | Description                                               |
| ------------- | --------------------------------------------------------- |
| Applicable    | Server and Client                                         |
471 472 473 474
| 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 已提交
475
### tmrDebugFlag
476

dengyihao's avatar
dengyihao 已提交
477 478
| Attribute     | Description               |
| ------------- | ------------------------- |
D
danielclow 已提交
479 480
| Applicable    | Server and Client         |
| Meaning       | Log level of timer module |
dengyihao's avatar
dengyihao 已提交
481 482
| Value Range   | same as debugFlag         |
| Default Value |                           |
483

D
danielclow 已提交
484
### uDebugFlag
485

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

### rpcDebugFlag

dengyihao's avatar
dengyihao 已提交
495 496 497
| Attribute     | Description             |
| ------------- | ----------------------- |
| Applicable    | Server and Client       |
498
| Meaning       | Log level of rpc module |
dengyihao's avatar
dengyihao 已提交
499 500
| Value Range   | same as debugFlag       |
| Default Value |                         |
501

D
danielclow 已提交
502
### jniDebugFlag
503

dengyihao's avatar
dengyihao 已提交
504 505 506
| Attribute     | Description             |
| ------------- | ----------------------- |
| Applicable    | Client Only             |
D
danielclow 已提交
507
| Meaning       | Log level of jni module |
dengyihao's avatar
dengyihao 已提交
508 509
| Value Range   | same as debugFlag       |
| Default Value |                         |
D
danielclow 已提交
510 511 512

### qDebugFlag

dengyihao's avatar
dengyihao 已提交
513 514
| Attribute     | Description               |
| ------------- | ------------------------- |
515
| Applicable    | Server and Client         |
dengyihao's avatar
dengyihao 已提交
516 517 518
| Meaning       | Log level of query module |
| Value Range   | same as debugFlag         |
| Default Value |                           |
519 520 521

### cDebugFlag

dengyihao's avatar
dengyihao 已提交
522 523
| Attribute     | Description         |
| ------------- | ------------------- |
524 525
| Applicable    | Client Only         |
| Meaning       | Log level of Client |
dengyihao's avatar
dengyihao 已提交
526 527
| Value Range   | same as debugFlag   |
| Default Value |                     |
528

D
danielclow 已提交
529
### dDebugFlag
530

dengyihao's avatar
dengyihao 已提交
531 532 533
| Attribute     | Description        |
| ------------- | ------------------ |
| Applicable    | Server Only        |
D
danielclow 已提交
534 535
| Meaning       | Log level of dnode |
| Value Range   | same as debugFlag  |
dengyihao's avatar
dengyihao 已提交
536
| Default Value | 135                |
537

D
danielclow 已提交
538
### vDebugFlag
539

dengyihao's avatar
dengyihao 已提交
540 541 542
| Attribute     | Description        |
| ------------- | ------------------ |
| Applicable    | Server Only        |
D
danielclow 已提交
543 544
| Meaning       | Log level of vnode |
| Value Range   | same as debugFlag  |
dengyihao's avatar
dengyihao 已提交
545
| Default Value |                    |
546

D
danielclow 已提交
547
### mDebugFlag
548

dengyihao's avatar
dengyihao 已提交
549 550 551 552 553 554
| Attribute     | Description               |
| ------------- | ------------------------- |
| Applicable    | Server Only               |
| Meaning       | Log level of mnode module |
| Value Range   | same as debugFlag         |
| Default Value | 135                       |
555

D
danielclow 已提交
556
### wDebugFlag
557

dengyihao's avatar
dengyihao 已提交
558 559 560 561 562 563
| Attribute     | Description             |
| ------------- | ----------------------- |
| Applicable    | Server Only             |
| Meaning       | Log level of WAL module |
| Value Range   | same as debugFlag       |
| Default Value | 135                     |
564

D
danielclow 已提交
565
### sDebugFlag
566

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

### tsdbDebugFlag

dengyihao's avatar
dengyihao 已提交
576 577 578 579 580 581
| Attribute     | Description              |
| ------------- | ------------------------ |
| Applicable    | Server Only              |
| Meaning       | Log level of TSDB module |
| Value Range   | same as debugFlag        |
| Default Value |                          |
582

D
danielclow 已提交
583
### tqDebugFlag
584

dengyihao's avatar
dengyihao 已提交
585 586 587 588 589 590
| Attribute     | Description            |
| ------------- | ---------------------- |
| Applicable    | Server only            |
| Meaning       | Log level of TQ module |
| Value Range   | same as debugFlag      |
| Default Value |                        |
591

D
danielclow 已提交
592
### fsDebugFlag
593

dengyihao's avatar
dengyihao 已提交
594 595 596 597 598 599
| Attribute     | Description            |
| ------------- | ---------------------- |
| Applicable    | Server only            |
| Meaning       | Log level of FS module |
| Value Range   | same as debugFlag      |
| Default Value |                        |
D
danielclow 已提交
600 601

### udfDebugFlag
602

dengyihao's avatar
dengyihao 已提交
603 604 605
| Attribute     | Description             |
| ------------- | ----------------------- |
| Applicable    | Server Only             |
D
danielclow 已提交
606
| Meaning       | Log level of UDF module |
dengyihao's avatar
dengyihao 已提交
607 608
| Value Range   | same as debugFlag       |
| Default Value |                         |
609

D
danielclow 已提交
610
### smaDebugFlag
611

dengyihao's avatar
dengyihao 已提交
612 613 614 615 616 617
| Attribute     | Description             |
| ------------- | ----------------------- |
| Applicable    | Server Only             |
| Meaning       | Log level of SMA module |
| Value Range   | same as debugFlag       |
| Default Value |                         |
618

D
danielclow 已提交
619
### idxDebugFlag
620

dengyihao's avatar
dengyihao 已提交
621 622 623 624 625 626
| Attribute     | Description               |
| ------------- | ------------------------- |
| Applicable    | Server Only               |
| Meaning       | Log level of index module |
| Value Range   | same as debugFlag         |
| Default Value |                           |
627

D
danielclow 已提交
628
### tdbDebugFlag
629

dengyihao's avatar
dengyihao 已提交
630 631 632 633 634 635
| Attribute     | Description             |
| ------------- | ----------------------- |
| Applicable    | Server Only             |
| Meaning       | Log level of TDB module |
| Value Range   | same as debugFlag       |
| Default Value |                         |
636

D
danielclow 已提交
637
## Schemaless Parameters
638

D
danielclow 已提交
639
### smlChildTableName
640

dengyihao's avatar
dengyihao 已提交
641 642 643 644 645 646
| Attribute     | Description                                |
| ------------- | ------------------------------------------ |
| Applicable    | Client only                                |
| Meaning       | Custom subtable name for schemaless writes |
| Type          | String                                     |
| Default Value | None                                       |
647

D
danielclow 已提交
648
### smlTagName
649

dengyihao's avatar
dengyihao 已提交
650 651 652 653 654 655
| Attribute     | Description                                                   |
| ------------- | ------------------------------------------------------------- |
| Applicable    | Client only                                                   |
| Meaning       | Default tag for schemaless writes without tag value specified |
| Type          | String                                                        |
| Default Value | _tag_null                                                     |
D
danielclow 已提交
656 657

### smlDataFormat
658

dengyihao's avatar
dengyihao 已提交
659 660 661 662 663 664
| Attribute   | Description                                                                         |
| ----------- | ----------------------------------------------------------------------------------- |
| Applicable  | Client only                                                                         |
| Meaning     | Whether schemaless columns are consistently ordered, depat, discarded since 3.0.3.0 |
| Value Range | 0: not consistent; 1: consistent.                                                   |
| Default     | 0                                                                                   |
665

G
gccgdb1234 已提交
666 667 668 669
## Compress Parameters

### compressMsgSize

dengyihao's avatar
dengyihao 已提交
670 671 672 673 674 675
| Attribute   | Description                                                                                                        |
| ----------- | ------------------------------------------------------------------------------------------------------------------ |
| Applicable  | Both Client and Server side                                                                                        |
| 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                                                                                                                 |
G
gccgdb1234 已提交
676 677


678 679 680 681
## Other Parameters

### enableCoreFile

dengyihao's avatar
dengyihao 已提交
682 683 684 685 686 687
| Attribute     | Description                                                                                                                                                                                                        |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 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 已提交
688
| 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 已提交
689

A
Alex Duan 已提交
690 691
### enableScience

dengyihao's avatar
dengyihao 已提交
692 693 694 695 696 697
| 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                                                             |
A
Alex Duan 已提交
698 699


D
danielclow 已提交
700 701
### udf

dengyihao's avatar
dengyihao 已提交
702 703 704 705 706 707
| Attribute     | Description                        |
| ------------- | ---------------------------------- |
| Applicable    | Server Only                        |
| Meaning       | Whether the UDF service is enabled |
| Value Range   | 0: disable UDF; 1: enabled UDF     |
| Default Value | 1                                  |
D
danielclow 已提交
708

709 710 711

## 3.0 Parameters

dengyihao's avatar
dengyihao 已提交
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
| #   |     **Parameter**      | **Applicable to 2.x ** | **Applicable to  3.0 **      | Current behavior 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  |      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                          |                         |
| 23  |     smlDataFormat      | No                     | Yes(discarded since 3.0.3.0) |                         |
| 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                          |                         |