xxq250
/
homework-jianmu
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request #18884 from taosdata/docs/TD-21058 

doc: reorganize 3.0 configuration parameters
This commit is contained in:
wade zhang 2022-12-10 19:16:19 +08:00 committed by GitHub
parent 5bca803424 df4716a90a
commit 73aed54fc6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 79 additions and 233 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

305
docs/en/14-reference/12-config/index.md
View File

@ -153,11 +153,11 @@ The parameters described in this document by the effect that they have on the sy
| Meaning | Execution policy for query statements | | Meaning | Execution policy for query statements |
| Unit | None | | Unit | None |
| Default | 1 | | Default | 1 |
| Notes | 1: Run queries on vnodes and not on qnodes | | 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. 2: Run subtasks without scan operators on qnodes and subtasks with scan operators on vnodes.
3: Only run scan operators on vnodes; run all other operators on qnodes. 3: Only run scan operators on vnodes; run all other operators on qnodes. |
### querySmaOptimize ### querySmaOptimize
@ -173,6 +173,14 @@ The parameters described in this document by the effect that they have on the sy
1: Enable SMA indexing and perform queries from suitable statements on precomputation results.| 1: Enable SMA indexing and perform queries from suitable statements on precomputation results.|
### countAlwaysReturnValue
| Attribute | Description |
| -------- | -------------------------------- |
| Applicable | Server only |
| Meaning | count()/hyperloglog() return value or not if the result data is NULL |
| Vlue Range | 0：Return empty line，1：Return 0 |
| Default | 1 |
### maxNumOfDistinctRes ### maxNumOfDistinctRes
@ -307,6 +315,14 @@ The charset that takes effect is UTF-8.
| Meaning | All data files are stored in this directory | | Meaning | All data files are stored in this directory |
| Default Value | /var/lib/taos | | Default Value | /var/lib/taos |
### tempDir
| Attribute | Description |
| -------- | ------------------------------------------ |
| Applicable | Server only |
| Meaning | The directory where to put all the temporary files generated during system running |
| Default | /tmp |
### minimalTmpDirGB ### minimalTmpDirGB
| Attribute | Description | | Attribute | Description |
@ -336,63 +352,8 @@ The charset that takes effect is UTF-8.
| Value Range | 0-4096 | | Value Range | 0-4096 |
| Default Value | 2x the CPU cores | | Default Value | 2x the CPU cores |
## Time Parameters
### statusInterval ## Continuous Query Parameters
| Attribute | Description |
| -------- | --------------------------- |
| Applicable | Server Only |
| Meaning | the interval of dnode reporting status to mnode |
| Unit | second |
| Value Range | 1-10 |
| Default Value | 1 |
### shellActivityTimer
| Attribute | Description |
| -------- | --------------------------------- |
| Applicable | Server and Client |
| Meaning | The interval for TDengine CLI to send heartbeat to mnode |
| Unit | second |
| Value Range | 1-120 |
| Default Value | 3 |
## Performance Optimization Parameters
### numOfCommitThreads
| Attribute | Description |
| -------- | ---------------------- |
| Applicable | Server Only |
| Meaning | Maximum of threads for committing to disk |
| Default Value | |
## Compression Parameters
### compressMsgSize
| Attribute | Description |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Applicable | Server Only |
| Meaning | The threshold for message size to compress the message. | Set the value to 64330 bytes for good message compression. |
| Unit | bytes |
| Value Range | 0: already compress; >0: compress when message exceeds it; -1: always uncompress |
| Default Value | -1 |
### compressColData
| Attribute | Description |
| -------- | --------------------------------------------------------------------------------------- |
| Applicable | Server Only |
| Meaning | The threshold for size of column data to trigger compression for the query result |
| Unit | bytes |
| Value Range | 0: always compress; >0: only compress when the size of any column data exceeds the threshold; -1: always uncompress |
| Default Value | -1 |
| Default Value | -1 |
| Note | available from version 2.3.0.0 | |
## Continuous Query Parameters |
### minSlidingTime ### minSlidingTime
@ -686,172 +647,62 @@ To prevent system resource from being exhausted by multiple concurrent streams,
| Value Range | 0: disable UDF; 1: enabled UDF | | Value Range | 0: disable UDF; 1: enabled UDF |
| Default Value | 1 | | Default Value | 1 |
## Parameter Comparison of TDengine 2.x and 3.0
| # | **Parameter** | **In 2.x** | **In 3.0** | ## 3.0 Parameters
| --- | :-----------------: | --------------- | --------------- |
| 1 | firstEp | Yes | Yes | | # | **参数** | **Applicable to 2.x ** | **Applicable to 3.0 ** | Current behavior in 3.0 |
| 2 | secondEp | Yes | Yes | | --- | :---------------------: | --------------- | --------------- | ------------------------------------------------- |
| 3 | fqdn | Yes | Yes | | 1 | firstEp | Yes | Yes | |
| 4 | serverPort | Yes | Yes | | 2 | secondEp | Yes | Yes | |
| 5 | maxShellConns | Yes | Yes | | 3 | fqdn | Yes | Yes | |
| 6 | monitor | Yes | Yes | | 4 | serverPort | Yes | Yes | |
| 7 | monitorFqdn | No | Yes | | 5 | maxShellConns | Yes | Yes | |
| 8 | monitorPort | No | Yes | | 6 | monitor | Yes | Yes | |
| 9 | monitorInterval | Yes | Yes | | 7 | monitorFqdn | No | Yes | |
| 10 | monitorMaxLogs | No | Yes | | 8 | monitorPort | No | Yes | |
| 11 | monitorComp | No | Yes | | 9 | monitorInterval | Yes | Yes | |
| 12 | telemetryReporting | Yes | Yes | | 10 | queryPolicy | No | Yes | |
| 13 | telemetryInterval | No | Yes | | 11 | querySmaOptimize | No | Yes | |
| 14 | telemetryServer | No | Yes | | 12 | maxNumOfDistinctRes | Yes | Yes | |
| 15 | telemetryPort | No | Yes | | 13 | minSlidingTime | Yes | Yes | |
| 16 | queryPolicy | No | Yes | | 14 | minIntervalTime | Yes | Yes | |
| 17 | querySmaOptimize | No | Yes | | 15 | countAlwaysReturnValue | Yes | Yes | |
| 18 | queryRsmaTolerance | No | Yes | | 16 | dataDir | Yes | Yes | |
| 19 | queryBufferSize | Yes | Yes | | 17 | minimalDataDirGB | Yes | Yes | |
| 20 | maxNumOfDistinctRes | Yes | Yes | | 18 | supportVnodes | No | Yes | |
| 21 | minSlidingTime | Yes | Yes | | 19 | tempDir | Yes | Yes | |
| 22 | minIntervalTime | Yes | Yes | | 20 | minimalTmpDirGB | Yes | Yes | |
| 23 | countAlwaysReturnValue | Yes | Yes | | 21 | smlChildTableName | Yes | Yes | |
| 24 | dataDir | Yes | Yes | | 22 | smlTagName | Yes | Yes | |
| 25 | minimalDataDirGB | Yes | Yes | | 23 | smlDataFormat | No | Yes | |
| 26 | supportVnodes | No | Yes | | 24 | statusInterval | Yes | Yes | |
| 27 | tempDir | Yes | Yes | | 25 | logDir | Yes | Yes | |
| 28 | minimalTmpDirGB | Yes | Yes | | 26 | minimalLogDirGB | Yes | Yes | |
| 29 | compressMsgSize | Yes | Yes | | 27 | numOfLogLines | Yes | Yes | |
| 30 | compressColData | Yes | Yes | | 28 | asyncLog | Yes | Yes | |
| 31 | smlChildTableName | Yes | Yes | | 29 | logKeepDays | Yes | Yes | |
| 32 | smlTagName | Yes | Yes | | 30 | debugFlag | Yes | Yes | |
| 33 | smlDataFormat | No | Yes | | 31 | tmrDebugFlag | Yes | Yes | |
| 34 | statusInterval | Yes | Yes | | 32 | uDebugFlag | Yes | Yes | |
| 35 | shellActivityTimer | Yes | Yes | | 33 | rpcDebugFlag | Yes | Yes | |
| 36 | transPullupInterval | No | Yes | | 34 | jniDebugFlag | Yes | Yes | |
| 37 | mqRebalanceInterval | No | Yes | | 35 | qDebugFlag | Yes | Yes | |
| 38 | ttlUnit | No | Yes | | 36 | cDebugFlag | Yes | Yes | |
| 39 | ttlPushInterval | No | Yes | | 37 | dDebugFlag | Yes | Yes | |
| 40 | numOfTaskQueueThreads | No | Yes | | 38 | vDebugFlag | Yes | Yes | |
| 41 | numOfRpcThreads | No | Yes | | 39 | mDebugFlag | Yes | Yes | |
| 42 | numOfCommitThreads | Yes | Yes | | 40 | wDebugFlag | Yes | Yes | |
| 43 | numOfMnodeReadThreads | No | Yes | | 41 | sDebugFlag | Yes | Yes | |
| 44 | numOfVnodeQueryThreads | No | Yes | | 42 | tsdbDebugFlag | Yes | Yes | |
| 45 | numOfVnodeStreamThreads | No | Yes | | 43 | tqDebugFlag | No | Yes | |
| 46 | numOfVnodeFetchThreads | No | Yes | | 44 | fsDebugFlag | Yes | Yes | |
| 47 | numOfVnodeRsmaThreads | No | Yes | | 45 | udfDebugFlag | No | Yes | |
| 48 | numOfQnodeQueryThreads | No | Yes | | 46 | smaDebugFlag | No | Yes | |
| 49 | numOfQnodeFetchThreads | No | Yes | | 47 | idxDebugFlag | No | Yes | |
| 50 | numOfSnodeSharedThreads | No | Yes | | 48 | tdbDebugFlag | No | Yes | |
| 51 | numOfSnodeUniqueThreads | No | Yes | | 49 | metaDebugFlag | No | Yes | |
| 52 | rpcQueueMemoryAllowed | No | Yes | | 50 | timezone | Yes | Yes | |
| 53 | logDir | Yes | Yes | | 51 | locale | Yes | Yes | |
| 54 | minimalLogDirGB | Yes | Yes | | 52 | charset | Yes | Yes | |
| 55 | numOfLogLines | Yes | Yes | | 53 | udf | Yes | Yes | |
| 56 | asyncLog | Yes | Yes | | 54 | enableCoreFile | Yes | Yes | |
| 57 | logKeepDays | Yes | Yes |
| 60 | debugFlag | Yes | Yes |
| 61 | tmrDebugFlag | Yes | Yes |
| 62 | uDebugFlag | Yes | Yes |
| 63 | rpcDebugFlag | Yes | Yes |
| 64 | jniDebugFlag | Yes | Yes |
| 65 | qDebugFlag | Yes | Yes |
| 66 | cDebugFlag | Yes | Yes |
| 67 | dDebugFlag | Yes | Yes |
| 68 | vDebugFlag | Yes | Yes |
| 69 | mDebugFlag | Yes | Yes |
| 70 | wDebugFlag | Yes | Yes |
| 71 | sDebugFlag | Yes | Yes |
| 72 | tsdbDebugFlag | Yes | Yes |
| 73 | tqDebugFlag | No | Yes |
| 74 | fsDebugFlag | Yes | Yes |
| 75 | udfDebugFlag | No | Yes |
| 76 | smaDebugFlag | No | Yes |
| 77 | idxDebugFlag | No | Yes |
| 78 | tdbDebugFlag | No | Yes |
| 79 | metaDebugFlag | No | Yes |
| 80 | timezone | Yes | Yes |
| 81 | locale | Yes | Yes |
| 82 | charset | Yes | Yes |
| 83 | udf | Yes | Yes |
| 84 | enableCoreFile | Yes | Yes |
| 85 | arbitrator | Yes | No |
| 86 | numOfThreadsPerCore | Yes | No |
| 87 | numOfMnodes | Yes | No |
| 88 | vnodeBak | Yes | No |
| 89 | balance | Yes | No |
| 90 | balanceInterval | Yes | No |
| 91 | offlineThreshold | Yes | No |
| 92 | role | Yes | No |
| 93 | dnodeNopLoop | Yes | No |
| 94 | keepTimeOffset | Yes | No |
| 95 | rpcTimer | Yes | No |
| 96 | rpcMaxTime | Yes | No |
| 97 | rpcForceTcp | Yes | No |
| 98 | tcpConnTimeout | Yes | No |
| 99 | syncCheckInterval | Yes | No |
| 100 | maxTmrCtrl | Yes | No |
| 101 | monitorReplica | Yes | No |
| 102 | smlTagNullName | Yes | No |
| 103 | keepColumnName | Yes | No |
| 104 | ratioOfQueryCores | Yes | No |
| 105 | maxStreamCompDelay | Yes | No |
| 106 | maxFirstStreamCompDelay | Yes | No |
| 107 | retryStreamCompDelay | Yes | No |
| 108 | streamCompDelayRatio | Yes | No |
| 109 | maxVgroupsPerDb | Yes | No |
| 110 | maxTablesPerVnode | Yes | No |
| 111 | minTablesPerVnode | Yes | No |
| 112 | tableIncStepPerVnode | Yes | No |
| 113 | cache | Yes | No |
| 114 | blocks | Yes | No |
| 115 | days | Yes | No |
| 116 | keep | Yes | No |
| 117 | minRows | Yes | No |
| 118 | maxRows | Yes | No |
| 119 | quorum | Yes | No |
| 120 | comp | Yes | No |
| 121 | walLevel | Yes | No |
| 122 | fsync | Yes | No |
| 123 | replica | Yes | No |
| 124 | partitions | Yes | No |
| 125 | quorum | Yes | No |
| 126 | update | Yes | No |
| 127 | cachelast | Yes | No |
| 128 | maxSQLLength | Yes | No |
| 129 | maxWildCardsLength | Yes | No |
| 130 | maxRegexStringLen | Yes | No |
| 131 | maxNumOfOrderedRes | Yes | No |
| 132 | maxConnections | Yes | No |
| 133 | mnodeEqualVnodeNum | Yes | No |
| 134 | http | Yes | No |
| 135 | httpEnableRecordSql | Yes | No |
| 136 | httpMaxThreads | Yes | No |
| 137 | restfulRowLimit | Yes | No |
| 138 | httpDbNameMandatory | Yes | No |
| 139 | httpKeepAlive | Yes | No |
| 140 | enableRecordSql | Yes | No |
| 141 | maxBinaryDisplayWidth | Yes | No |
| 142 | stream | Yes | No |
| 143 | retrieveBlockingModel | Yes | No |
| 144 | tsdbMetaCompactRatio | Yes | No |
| 145 | defaultJSONStrType | Yes | No |
| 146 | walFlushSize | Yes | No |
| 147 | keepTimeOffset | Yes | No |
| 148 | flowctrl | Yes | No |
| 149 | slaveQuery | Yes | No |
| 150 | adjustMaster | Yes | No |
| 151 | topicBinaryLen | Yes | No |
| 152 | telegrafUseFieldNum | Yes | No |
| 153 | deadLockKillQuery | Yes | No |
| 154 | clientMerge | Yes | No |
| 155 | sdbDebugFlag | Yes | No |
| 156 | odbcDebugFlag | Yes | No |
| 157 | httpDebugFlag | Yes | No |
| 158 | monDebugFlag | Yes | No |
| 159 | cqDebugFlag | Yes | No |
| 160 | shortcutFlag | Yes | No |
| 161 | probeSeconds | Yes | No |
| 162 | probeKillSeconds | Yes | No |
| 163 | probeInterval | Yes | No |
| 164 | lossyColumns | Yes | No |
| 165 | fPrecision | Yes | No |
| 166 | dPrecision | Yes | No |
| 167 | maxRange | Yes | No |
| 168 | range | Yes | No |

7
docs/zh/14-reference/12-config/index.md
View File

@ -640,12 +640,7 @@ charset 的有效值是 UTF-8。
| 取值范围 | 0: 不启动；1：启动 | | 取值范围 | 0: 不启动；1：启动 |
| 缺省值 | 1 | | 缺省值 | 1 |
## 3.0 配置参数列表 ## 3.0 中有效的配置参数列表
:::note
对于 2.x 版本中适用但在 3.0 版本中废弃的参数，其当前行为会有特别说明
:::
| # | **参数** | **适用于 2.X ** | **适用于 3.0 ** | 3.0 版本的当前行为 | | # | **参数** | **适用于 2.X ** | **适用于 3.0 ** | 3.0 版本的当前行为 |
| --- | :---------------------: | --------------- | --------------- | ------------------------------------------------- | | --- | :---------------------: | --------------- | --------------- | ------------------------------------------------- |