You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by qi...@apache.org on 2022/11/24 02:42:07 UTC
[iotdb] branch master updated: [IOTDB-5032] ConfigNode and DataNode Manual and User doc for cluster V1.0 (#8121)
This is an automated email from the ASF dual-hosted git repository.
qiaojialin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 5c3f4e12fd [IOTDB-5032] ConfigNode and DataNode Manual and User doc for cluster V1.0 (#8121)
5c3f4e12fd is described below
commit 5c3f4e12fda966cff0638a537aed85465f5a50f6
Author: Itami Sho <42...@users.noreply.github.com>
AuthorDate: Thu Nov 24 10:42:03 2022 +0800
[IOTDB-5032] ConfigNode and DataNode Manual and User doc for cluster V1.0 (#8121)
---
docs/UserGuide/FAQ/Frequently-asked-questions.md | 2 +-
docs/UserGuide/QuickStart/Files.md | 15 +-
.../Reference/ConfigNode-Config-Manual.md | 86 ++++-----
docs/UserGuide/Reference/DataNode-Config-Manual.md | 96 ++++++----
.../zh/UserGuide/FAQ/Frequently-asked-questions.md | 2 +-
docs/zh/UserGuide/QuickStart/Files.md | 14 +-
.../Reference/ConfigNode-Config-Manual.md | 177 +++++++++--------
.../UserGuide/Reference/DataNode-Config-Manual.md | 210 +++++++++++----------
8 files changed, 328 insertions(+), 274 deletions(-)
diff --git a/docs/UserGuide/FAQ/Frequently-asked-questions.md b/docs/UserGuide/FAQ/Frequently-asked-questions.md
index 33affc6edc..96117c9730 100644
--- a/docs/UserGuide/FAQ/Frequently-asked-questions.md
+++ b/docs/UserGuide/FAQ/Frequently-asked-questions.md
@@ -87,7 +87,7 @@ By default settings, the logs are stored under ```IOTDB_HOME/logs```. You can ch
**Where can I find IoTDB data files?**
-By default settings, the data files (including tsfile, metadata, and WAL files) are stored under ```IOTDB_HOME/data```.
+By default settings, the data files (including tsfile, metadata, and WAL files) are stored under ```IOTDB_HOME/data/datanode```.
**How do I know how many time series are stored in IoTDB?**
diff --git a/docs/UserGuide/QuickStart/Files.md b/docs/UserGuide/QuickStart/Files.md
index eafebfdc72..2540965dc9 100644
--- a/docs/UserGuide/QuickStart/Files.md
+++ b/docs/UserGuide/QuickStart/Files.md
@@ -115,13 +115,14 @@ The data directory path included in storage directory setting are: base_dir, dat
An example of the configuration items are as follows:
```
-base_dir = $IOTDB_HOME/data
-data_dirs = /data1/data, /data2/data, /data3/data
-multi_dir_strategy=MaxDiskUsableSpaceFirstStrategy
-wal_dir= $IOTDB_HOME/data/wal
+dn_system_dir = $IOTDB_HOME/data/datanode/system
+dn_data_dirs = /data1/datanode/data, /data2/datanode/data, /data3/datanode/data
+dn_multi_dir_strategy=MaxDiskUsableSpaceFirstStrategy
+dn_wal_dir= $IOTDB_HOME/data/datanode/wal
```
After setting the configuration, the system will:
-* Save all system files in $IOTDB_HOME/data
-* Save TsFile in /data1/data, /data2/data, /data3/data. And the choosing strategy is `MaxDiskUsableSpaceFirstStrategy`, when data writes to the disk, the system will automatically select a directory with the largest remaining disk space to write data.
-* Save WAL data in $IOTDB_HOME/data/wal
+* Save all system files in $IOTDB_HOME/data/datanode/system
+* Save TsFile in /data1/datanode/data, /data2/datanode/data, /data3/datanode/data. And the choosing strategy is `MaxDiskUsableSpaceFirstStrategy`, when data writes to the disk, the system will automatically select a directory with the largest remaining disk space to write data.
+* Save WAL data in $IOTDB_HOME/data/datanode/wal
+*
diff --git a/docs/UserGuide/Reference/ConfigNode-Config-Manual.md b/docs/UserGuide/Reference/ConfigNode-Config-Manual.md
index 999c68e77f..683a752368 100644
--- a/docs/UserGuide/Reference/ConfigNode-Config-Manual.md
+++ b/docs/UserGuide/Reference/ConfigNode-Config-Manual.md
@@ -21,12 +21,14 @@
# ConfigNode Configuration
-IoTDB ConfigNode files are under `confignode/conf`.
+IoTDB ConfigNode files are under `conf`.
* `confignode-env.sh/bat`：Environment configurations, in which we could set the memory allocation of ConfigNode.
* `iotdb-confignode.properties`：IoTDB ConfigNode system configurations.
+* `iotdb-common.properties`：IoTDB common configurations.
+
## Environment Configuration File（confignode-env.sh/bat）
The environment configuration file is mainly used to configure the Java environment related parameters when ConfigNode is running, such as JVM related configuration. This part of the configuration is passed to the JVM when the ConfigNode starts.
@@ -61,69 +63,69 @@ The details of each parameter are as follows:
|Effective|After restarting system|
-## ConfigNode Configuration File（iotdb-confignode.properties）
+## ConfigNode Configuration File (iotdb-confignode.properties and iotdb-common.properties)
The global configuration of cluster is in ConfigNode.
### Internal RPC Service Configurations
-* internal\_address
+* cn\_internal\_address
-|Name| internal\_address |
-|:---:|:---|
-|Description| ConfigNode internal service address |
-|Type| String |
-|Default| 0.0.0.0|
-|Effective|After restarting system|
+| Name | cn\_internal\_address |
+|:-----------:|:------------------------------------|
+| Description | ConfigNode internal service address |
+| Type | String |
+| Default | 127.0.0.1 |
+| Effective | After restarting system |
-* internal\_port
+* cn\_internal\_port
-|Name| internal\_port |
+|Name| cn\_internal\_port |
|:---:|:---|
|Description| ConfigNode internal service port|
|Type| Short Int : [0,65535] |
|Default| 22277 |
|Effective|After restarting system|
-* target\_config\_nodes
+* cn\_target\_config\_node\_list
-|Name| target\_config\_nodes |
-|:---:|:---|
+|Name| cn\_target\_config\_node\_list |
+|:---:|:----------------------------------------------------------------------|
|Description| Target ConfigNode address, for current ConfigNode to join the cluster |
-|Type| String |
-|Default| 127.0.0.1:22277 |
-|Effective|After restarting system|
+|Type| String |
+|Default| 127.0.0.1:22277 |
+|Effective| After restarting system |
-* rpc\_thrift\_compression\_enable
+* cn\_rpc\_thrift\_compression\_enable
-|Name| rpc\_thrift\_compression\_enable |
+|Name| cn\_rpc\_thrift\_compression\_enable |
|:---:|:---|
|Description| Whether enable thrift's compression (using GZIP).|
|Type|Boolean|
|Default| false |
|Effective|After restarting system|
-* rpc\_advanced\_compression\_enable
+* cn\_rpc\_advanced\_compression\_enable
-|Name| rpc\_advanced\_compression\_enable |
+|Name| cn\_rpc\_advanced\_compression\_enable |
|:---:|:---|
|Description| Whether enable thrift's advanced compression.|
|Type|Boolean|
|Default| false |
|Effective|After restarting system|
-* rpc\_max\_concurrent\_client\_num
+* cn\_rpc\_max\_concurrent\_client\_num
-|Name| rpc\_max\_concurrent\_client\_num |
+|Name| cn\_rpc\_max\_concurrent\_client\_num |
|:---:|:---|
|Description| Max concurrent rpc connections|
|Type| Short Int : [0,65535] |
|Description| 65535 |
|Effective|After restarting system|
-* thrift\_max\_frame\_size
+* cn\_thrift\_max\_frame\_size
-|Name| thrift\_max\_frame\_size |
+|Name| cn\_thrift\_max\_frame\_size |
|:---:|:---|
|Description| Max size of bytes of each thrift RPC request/response|
|Type| Long |
@@ -131,9 +133,9 @@ The global configuration of cluster is in ConfigNode.
|Default| 536870912 |
|Effective|After restarting system|
-* thrift\_init\_buffer\_size
+* cn\_thrift\_init\_buffer\_size
-|Name| thrift\_init\_buffer\_size |
+|Name| cn\_thrift\_init\_buffer\_size |
|:---:|:---|
|Description| Initial size of bytes of buffer that thrift used |
|Type| long |
@@ -143,9 +145,9 @@ The global configuration of cluster is in ConfigNode.
### Replication and Consensus
-* consensus\_port
+* cn\_consensus\_port
-|Name| consensus\_port |
+|Name| cn\_consensus\_port |
|:---:|:---|
|Description| ConfigNode data Consensus Port |
|Type| Short Int : [0,65535] |
@@ -202,9 +204,9 @@ The global configuration of cluster is in ConfigNode.
### HeartBeat
-* heartbeat\_interval
+* heartbeat\_interval\_in\_ms
-|Name| heartbeat\_interval |
+|Name| heartbeat\_interval\_in\_ms |
|:---:|:---|
|Description| Heartbeat interval in the cluster nodes |
|Type| Long |
@@ -235,9 +237,9 @@ The global configuration of cluster is in ConfigNode.
### Database
-* default\_ttl
+* default\_ttl\_in\_ms
-|Name| default\_ttl |
+|Name| default\_ttl\_in\_ms |
|:---:|:---|
|Description| Default ttl when each database created |
|Type| Long |
@@ -257,23 +259,23 @@ The global configuration of cluster is in ConfigNode.
### Data Directory
-* system\_dir
+* cn\_system\_dir
-|Name| system\_dir |
+|Name| cn\_system\_dir |
|:---:|:---|
|Description| ConfigNode system data dir |
|Type| String |
|Default| data/system（Windows：data\\system） |
|Effective|After restarting system|
-* consensus\_dir
+* cn\_consensus\_dir
-|Name| consensus\_dir |
-|:---:|:---|
-|Description| ConfigNode Consensus protocol data dir |
-|Type| String |
-|Default| data/consensus（Windows：data\\consensus） |
-|Effective|After restarting system|
+|Name| cn\_consensus\_dir |
+|:---:|:---------------------------------------------------------------|
+|Description| ConfigNode Consensus protocol data dir |
+|Type| String |
+|Default| data/confignode/consensus（Windows：data\\confignode\\consensus） |
+|Effective| After restarting system |
* udf\_lib\_dir
diff --git a/docs/UserGuide/Reference/DataNode-Config-Manual.md b/docs/UserGuide/Reference/DataNode-Config-Manual.md
index 303db9b5ab..beb20442c8 100644
--- a/docs/UserGuide/Reference/DataNode-Config-Manual.md
+++ b/docs/UserGuide/Reference/DataNode-Config-Manual.md
@@ -21,15 +21,17 @@
# DataNode/Standalone Configuration Parameters
-We use the same configuration files for IoTDB DataNode and Standalone version, all under the `datanode/conf`.
+We use the same configuration files for IoTDB DataNode and Standalone version, all under the `conf`.
* `datanode-env.sh/bat`：Environment configurations, in which we could set the memory allocation of DataNode and Standalone.
* `iotdb-datanode.properties`：IoTDB DataNode/Standalone system configurations.
+* `iotdb-common.properties`：IoTDB common configurations.
+
## Hot Modification Configuration
-For the convenience of users, IoTDB provides users with hot modification function, that is, modifying some configuration parameters in `iotdb-datanode.properties` during the system operation and applying them to the system immediately.
+For the convenience of users, IoTDB provides users with hot modification function, that is, modifying some configuration parameters in `iotdb-datanode.properties` and `iotdb-common.properties` during the system operation and applying them to the system immediately.
In the parameters described below, these parameters whose way of `Effective` is `trigger` support hot modification.
Trigger way: The client sends the command(sql) `load configuration` to the IoTDB server.
@@ -102,22 +104,22 @@ The user and passwords are in ${IOTDB\_CONF}/conf/jmx.password.
The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
-## DataNode/Standalone Configuration File (iotdb-datanode.properties)
+## DataNode/Standalone Configuration File (iotdb-datanode.properties and iotdb-common.properties)
### Client RPC Service
-* rpc\_address
+* dn\_rpc\_address
-|Name| rpc\_address |
-|:---:|:---|
-|Description| The client rpc service listens on the address.|
-|Type|String|
-|Default| 0.0.0.0 |
-|Effective|After restarting system|
+|Name| dn\_rpc\_address |
+|:---:|:-----------------------------------------------|
+|Description| The client rpc service listens on the address. |
+|Type| String |
+|Default| 127.0.0.1 |
+|Effective| After restarting system |
-* rpc\_port
+* dn\_rpc\_port
-|Name| rpc\_port |
+|Name| dn\_rpc\_port |
|:---:|:---|
|Description| The client rpc service listens on the port.|
|Type|Short Int : [0,65535]|
@@ -142,6 +144,24 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
|Default| false |
|Effective|After restarting system|
+* rpc\_selector\_thread\_count
+
+|Name| rpc\_selector\_thread\_count |
+|:---:|:-----------------------------------|
+|Description| The number of rpc selector thread. |
+|Type| int |
+|Default| false |
+|Effective| After restarting system |
+
+* rpc\_min\_concurrent\_client\_num
+
+|Name| rpc\_min\_concurrent\_client\_num |
+|:---:|:-----------------------------------|
+|Description| Minimum concurrent rpc connections |
+|Type| Short Int : [0,65535] |
+|Description| 1 |
+|Effective| After restarting system |
+
* rpc\_max\_concurrent\_client\_num
|Name| rpc\_max\_concurrent\_client\_num |
@@ -183,20 +203,20 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
* mpp\_data\_exchange\_core\_pool\_size
-|Name| mpp\_data\_exchange\_core\_pool\_size |
-|:---:|:---|
-|Description| Core size of ThreadPool of MPP data exchange|
-|Type| int |
-|Default| 1 |
-|Effective|After restarting system|
+|Name| mpp\_data\_exchange\_core\_pool\_size |
+|:---:|:---------------------------------------------|
+|Description| Core size of ThreadPool of MPP data exchange |
+|Type| int |
+|Default| 10 |
+|Effective| After restarting system |
* mpp\_data\_exchange\_max\_pool\_size
|Name| mpp\_data\_exchange\_max\_pool\_size |
-|:---:|:---|
+|:---:|:--|
|Description| Max size of ThreadPool of MPP data exchange |
|Type| int |
-|Default| 5 |
+|Default| 10 |
|Effective|After restarting system|
* mpp\_data\_exchange\_keep\_alive\_time\_in\_ms
@@ -237,50 +257,50 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
### DataNode Internal Service
-* internal\_address
+* dn\_internal\_address
-|Name| internal\_address |
+|Name| dn\_internal\_address |
|:---:|:---|
|Description| DataNode internal service host/IP |
|Type| string |
|Default| 127.0.0.1 |
|Effective|After restarting system|
-* internal\_port
+* dn\_internal\_port
-|Name| internal\_address |
-|:---:|:---|
+|Name| dn\_internal\_port |
+|:---:|:-------------------------------|
|Description| DataNode internal service port |
-|Type| int |
-|Default| 9003 |
-|Effective|After restarting system|
+|Type| int |
+|Default| 9003 |
+|Effective| After restarting system |
-* data\_region\_consensus\_port
+* dn\_data\_region\_consensus\_port
-|Name| data\_region\_consensus\_port |
+|Name| dn\_data\_region\_consensus\_port |
|:---:|:---|
|Description| DataNode Data replica communication port for consensus |
|Type| int |
|Default| 40010 |
|Effective|After restarting system|
-* schema\_region\_consensus\_port
+* dn\_schema\_region\_consensus\_port
-|Name| schema\_region\_consensus\_port |
+|Name| dn\_schema\_region\_consensus\_port |
|:---:|:---|
|Description| DataNode Schema replica communication port for consensus |
|Type| int |
|Default| 50010 |
|Effective|After restarting system|
-* target\_config\_nodes
+* dn\_target\_config\_node\_list
-|Name| target\_config\_nodes |
-|:---:|:---|
+|Name| dn\_target\_config\_node\_list |
+|:---:|:------------------------------------------------|
|Description| ConfigNode Address for DataNode to join cluster |
-|Type| String |
-|Default| 127.0.0.1:22277 |
-|Effective|After restarting system|
+|Type| String |
+|Default| 127.0.0.1:22277 |
+|Effective| After restarting system |
### File Layer
diff --git a/docs/zh/UserGuide/FAQ/Frequently-asked-questions.md b/docs/zh/UserGuide/FAQ/Frequently-asked-questions.md
index 19644359bf..2e976e0267 100644
--- a/docs/zh/UserGuide/FAQ/Frequently-asked-questions.md
+++ b/docs/zh/UserGuide/FAQ/Frequently-asked-questions.md
@@ -89,7 +89,7 @@ Readme.md
**在哪里可以找到 IoTDB 的数据文件**
-在默认的设置里，数据文件（包含 TsFile，metadata，WAL）被存储在```IOTDB_HOME/data```文件夹。
+在默认的设置里，数据文件（包含 TsFile，metadata，WAL）被存储在```IOTDB_HOME/data/datanode```文件夹。
**如何知道 IoTDB 中存储了多少时间序列**
diff --git a/docs/zh/UserGuide/QuickStart/Files.md b/docs/zh/UserGuide/QuickStart/Files.md
index 8274a65ddb..119f35c7f6 100644
--- a/docs/zh/UserGuide/QuickStart/Files.md
+++ b/docs/zh/UserGuide/QuickStart/Files.md
@@ -110,13 +110,13 @@ IoTDB 涉及到的所有数据目录路径有：data_dirs, multi_dir_strategy, s
以下我们给出一个用户对五个目录都进行自行配置的例子。
```
-system_dir = $IOTDB_HOME/data
-data_dirs = /data1/data, /data2/data, /data3/data
-multi_dir_strategy=MaxDiskUsableSpaceFirstStrategy
-wal_dir= $IOTDB_HOME/data/wal
+dn_system_dir = $IOTDB_HOME/data/datanode/system
+dn_data_dirs = /data1/datanode/data, /data2/datanode/data, /data3/datanode/data
+dn_multi_dir_strategy=MaxDiskUsableSpaceFirstStrategy
+dn_wal_dir= $IOTDB_HOME/data/datanode/wal
```
按照上述配置，系统会：
-* 将 TsFile 存储在路径/data1/data、路径/data2/data 和路径 data3/data3 中。且对这三个路径的选择策略是：`优先选择磁盘剩余空间最大的目录`，即在每次数据持久化到磁盘时系统会自动选择磁盘剩余空间最大的一个目录将数据进行写入
-* 将系统文件存储在$IOTDB_HOME/data
-* 将写前日志文件存储在$IOTDB_HOME/data/wal
+* 将 TsFile 存储在路径 /data1/datanode/data、路径 /data2/datanode/data 和路径 /data3/datanode/data 中。且对这三个路径的选择策略是：`优先选择磁盘剩余空间最大的目录`，即在每次数据持久化到磁盘时系统会自动选择磁盘剩余空间最大的一个目录将数据进行写入
+* 将系统文件存储在$IOTDB_HOME/data/datanode/data
+* 将写前日志文件存储在$IOTDB_HOME/data/datanode/wal
diff --git a/docs/zh/UserGuide/Reference/ConfigNode-Config-Manual.md b/docs/zh/UserGuide/Reference/ConfigNode-Config-Manual.md
index 5b3133546f..da0d53c71f 100644
--- a/docs/zh/UserGuide/Reference/ConfigNode-Config-Manual.md
+++ b/docs/zh/UserGuide/Reference/ConfigNode-Config-Manual.md
@@ -21,12 +21,14 @@
# ConfigNode 配置参数
-IoTDB ConfigNode 配置文件均位于 IoTDB 安装目录：`confignode/conf`文件夹下。
+IoTDB ConfigNode 配置文件均位于 IoTDB 安装目录：`conf`文件夹下。
* `confignode-env.sh/bat`：环境配置项的配置文件，可以配置 ConfigNode 的内存大小。
* `iotdb-confignode.properties`：IoTDB ConfigNode 的配置文件。
+* `iotdb-common.properties`：IoTDB 的通用配置文件。
+
## 环境配置项（confignode-env.sh/bat）
环境配置项主要用于对 ConfigNode 运行的 Java 环境相关参数进行配置，如 JVM 相关配置。ConfigNode 启动时，此部分配置会被传给 JVM，详细配置项说明如下：
@@ -59,90 +61,99 @@ IoTDB ConfigNode 配置文件均位于 IoTDB 安装目录：`confignode/conf`文
|改后生效方式|重启服务生效|
-## 系统配置项（iotdb-confignode.properties）
+## 系统配置项（iotdb-confignode.properties 和 iotdb-common.properties）
IoTDB 集群的全局配置通过 ConfigNode 配置。
### Internal RPC Service 配置
-* internal\_address
+* cn\_internal\_address
-|名字| internal\_address |
-|:---:|:---|
-|描述| ConfigNode 集群内部地址 |
-|类型| String |
-|默认值| 0.0.0.0|
-|改后生效方式|重启服务生效|
+| 名字 | cn\_internal\_address |
+|:------:|:----------------------|
+| 描述 | ConfigNode 集群内部地址 |
+| 类型 | String |
+| 默认值 | 127.0.0.1 |
+| 改后生效方式 | 重启服务生效 |
-* internal\_port
+* cn\_internal\_port
-|名字| internal\_port |
-|:---:|:---|
-|描述| ConfigNode 集群服务监听端口|
-|类型| Short Int : [0,65535] |
-|默认值| 6667 |
-|改后生效方式|重启服务生效|
+| 名字 | cn\_internal\_port |
+|:------:|:----------------------|
+| 描述 | ConfigNode 集群服务监听端口 |
+| 类型 | Short Int : [0,65535] |
+| 默认值 | 6667 |
+| 改后生效方式 | 重启服务生效 |
-* target\_config\_nodes
+* cn\_consensus\_port
-|名字| target\_config\_nodes |
-|:---:|:---|
-|描述| 目标 ConfigNode 地址，ConfigNode 通过此地址加入集群 |
-|类型| String |
-|默认值| 127.0.0.1:22277 |
-|改后生效方式|重启服务生效|
+| 名字 | cn\_consensus\_port |
+|:------:|:----------------------|
+| 描述 | ConfigNode 的共识协议通信端口 |
+| 类型 | Short Int : [0,65535] |
+| 默认值 | 22278 |
+| 改后生效方式 | 重启服务生效 |
-* rpc\_thrift\_compression\_enable
+* cn\_target\_config\_node\_list
-|名字| rpc\_thrift\_compression\_enable |
-|:---:|:---|
-|描述| 是否启用 thrift 的压缩机制。|
-|类型| Boolean |
-|默认值| false |
-|改后生效方式|重启服务生效|
+| 名字 | cn\_target\_config\_node\_list |
+|:------:|:--------------------------------------|
+| 描述 | 目标 ConfigNode 地址，ConfigNode 通过此地址加入集群 |
+| 类型 | String |
+| 默认值 | 127.0.0.1:22277 |
+| 改后生效方式 | 重启服务生效 |
-* rpc\_advanced\_compression\_enable
+* cn\_rpc\_thrift\_compression\_enable
-|名字| rpc\_advanced\_compression\_enable |
-|:---:|:---|
-|描述| 是否启用 thrift 的自定制压缩机制。|
-|类型| Boolean |
-|默认值| false |
-|改后生效方式|重启服务生效|
+| 名字 | cn\_rpc\_thrift\_compression\_enable |
+|:------:|:-------------------------------------|
+| 描述 | 是否启用 thrift 的压缩机制。 |
+| 类型 | Boolean |
+| 默认值 | false |
+| 改后生效方式 | 重启服务生效 |
-* rpc\_max\_concurrent\_client\_num
+* cn\_rpc\_advanced\_compression\_enable
-|名字| rpc\_max\_concurrent\_client\_num |
-|:---:|:---|
-|描述| 最大连接数。|
-|类型| Short Int : [0,65535] |
-|默认值| 65535 |
-|改后生效方式|重启服务生效|
+| 名字 | cn\_rpc\_advanced\_compression\_enable |
+|:------:|:---------------------------------------|
+| 描述 | 是否启用 thrift 的自定制压缩机制。 |
+| 类型 | Boolean |
+| 默认值 | false |
+| 改后生效方式 | 重启服务生效 |
-* thrift\_max\_frame\_size
+* cn\_rpc\_max\_concurrent\_client\_num
-|名字| thrift\_max\_frame\_size |
-|:---:|:---|
-|描述| RPC 请求/响应的最大字节数|
-|类型| long |
-|默认值| 536870912 （默认值512MB，应大于等于 512 * 1024 * 1024) |
-|改后生效方式|重启服务生效|
+| 名字 | cn\_rpc\_max\_concurrent\_client\_num |
+|:------:|:--------------------------------------|
+| 描述 | 最大连接数。 |
+| 类型 | Short Int : [0,65535] |
+| 默认值 | 65535 |
+| 改后生效方式 | 重启服务生效 |
-* thrift\_init\_buffer\_size
+* cn\_thrift\_max\_frame\_size
-|名字| thrift\_init\_buffer\_size |
-|:---:|:---|
-|描述| 字节数 |
-|类型| Long |
-|默认值| 1024 |
-|改后生效方式|重启服务生效|
+| 名字 | cn\_thrift\_max\_frame\_size |
+|:------:|:---------------------------------------------|
+| 描述 | RPC 请求/响应的最大字节数 |
+| 类型 | long |
+| 默认值 | 536870912 （默认值512MB，应大于等于 512 * 1024 * 1024) |
+| 改后生效方式 | 重启服务生效 |
+
+* cn\_thrift\_init\_buffer\_size
+
+| 名字 | cn\_thrift\_init\_buffer\_size |
+|:------:|:-------------------------------|
+| 描述 | 字节数 |
+| 类型 | Long |
+| 默认值 | 1024 |
+| 改后生效方式 | 重启服务生效 |
### 副本及共识协议
-* consensus\_port
+* cn\_consensus\_port
-|名字| consensus\_port |
+|名字| cn\_consensus\_port |
|:---:|:---|
|描述| ConfigNode 的共识协议通信端口 |
|类型| Short Int : [0,65535] |
@@ -197,9 +208,9 @@ IoTDB 集群的全局配置通过 ConfigNode 配置。
### 心跳配置
-* heartbeat\_interval
+* heartbeat\_interval\_in\_ms
-|名字| heartbeat\_interval |
+|名字| heartbeat\_interval\_in\_ms |
|:---:|:---|
|描述| 集群节点间的心跳间隔 |
|类型| Long |
@@ -230,14 +241,14 @@ IoTDB 集群的全局配置通过 ConfigNode 配置。
### Database 配置
-* default\_ttl
+* default\_ttl\_in\_ms
-|名字| default\_ttl |
-|:---:|:---|
-|描述| 默认数据保留时间 |
-|类型| Long |
-|默认值| 无限 |
-|改后生效方式|重启服务生效|
+|名字| default\_ttl\_in\_ms |
+|:---:|:---------------------|
+|描述| 默认数据保留时间 |
+|类型| Long |
+|默认值| 无限 |
+|改后生效方式| 重启服务生效 |
* time\_partition\_interval
@@ -251,23 +262,23 @@ IoTDB 集群的全局配置通过 ConfigNode 配置。
### 数据目录
-* system\_dir
+* cn\_system\_dir
-|名字| system\_dir |
-|:---:|:---|
-|描述| ConfigNode 系统数据存储路径 |
-|类型| String |
-|默认值| data/system（Windows：data\\system） |
-|改后生效方式|重启服务生效|
+|名字| cn\_system\_dir |
+|:---:|:---------------------------------------------------------|
+|描述| ConfigNode 系统数据存储路径 |
+|类型| String |
+|默认值| data/confignode/system（Windows：data\\configndoe\\system） |
+|改后生效方式| 重启服务生效 |
-* consensus\_dir
+* cn\_consensus\_dir
-|名字| consensus\_dir |
-|:---:|:---|
-|描述| ConfigNode 共识协议数据存储路径 |
-|类型| String |
-|默认值| data/consensus（Windows：data\\consensus） |
-|改后生效方式|重启服务生效|
+|名字| cn\_consensus\_dir |
+|:---:|:---------------------------------------------------|
+|描述| ConfigNode 共识协议数据存储路径 |
+|类型| String |
+|默认值| data/confignode/consensus（Windows：data\\configndoe\\consensus） |
+|改后生效方式| 重启服务生效 |
* udf\_lib\_dir
diff --git a/docs/zh/UserGuide/Reference/DataNode-Config-Manual.md b/docs/zh/UserGuide/Reference/DataNode-Config-Manual.md
index f5f53efcd1..5d07d14eb4 100644
--- a/docs/zh/UserGuide/Reference/DataNode-Config-Manual.md
+++ b/docs/zh/UserGuide/Reference/DataNode-Config-Manual.md
@@ -21,12 +21,14 @@
# DataNode/Standalone 配置参数
-IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB 安装目录：`datanode/conf`文件夹下。
+IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB 安装目录：`conf`文件夹下。
* `datanode-env.sh/bat`：环境配置项的配置文件，可以配置 DataNode/Standalone 的内存大小。
* `iotdb-datanode.properties`：IoTDB DataNode 和单机版的配置文件。
+* `iotdb-common.properties`：IoTDB 的通用配置文件。
+
## 热修改配置项
为方便用户使用，IoTDB 为用户提供了热修改功能，即在系统运行过程中修改 `iotdb-datanode.properties` 中部分配置参数并即时应用到系统中。下面介绍的参数中，改后 生效方式为`触发生效`
@@ -83,24 +85,24 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB
|默认值|31999|
|改后生效方式|重启服务生效|
-## 系统配置项（iotdb-datanode.properties）
+## 系统配置项（iotdb-datanode.properties 和 iotdb-common.properties）
系统配置项是 IoTDB DataNode/Standalone 运行的核心配置，它主要用于设置 DataNode/Standalone 数据库引擎的参数。
### 客户端 RPC 服务配置
-* rpc\_address
+* dn\_rpc\_address
-|名字| rpc\_address |
-|:---:|:---|
-|描述| 客户端 RPC 服务监听地址 |
-|类型| String |
-|默认值| 0.0.0.0|
-|改后生效方式|重启服务生效|
+|名字| dn\_rpc\_address |
+|:---:|:-----------------|
+|描述| 客户端 RPC 服务监听地址 |
+|类型| String |
+|默认值| 127.0.0.1 |
+|改后生效方式| 重启服务生效 |
-* rpc\_port
+* dn\_rpc\_port
-|名字| rpc\_port |
+|名字| dn\_rpc\_port |
|:---:|:---|
|描述| Client RPC 服务监听端口|
|类型| Short Int : [0,65535] |
@@ -110,29 +112,47 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB
* rpc\_thrift\_compression\_enable
|名字| rpc\_thrift\_compression\_enable |
-|:---:|:---|
-|描述| 是否启用 thrift 的压缩机制。|
-|类型| Boolean |
-|默认值| false |
-|改后生效方式|重启服务生效|
+|:---:|:---------------------------------|
+|描述| 是否启用 thrift 的压缩机制 |
+|类型| Boolean |
+|默认值| false |
+|改后生效方式| 重启服务生效 |
* rpc\_advanced\_compression\_enable
|名字| rpc\_advanced\_compression\_enable |
-|:---:|:---|
-|描述| 是否启用 thrift 的自定制压缩机制。|
-|类型| Boolean |
-|默认值| false |
-|改后生效方式|重启服务生效|
+|:---:|:-----------------------------------|
+|描述| 是否启用 thrift 的自定制压缩机制 |
+|类型| Boolean |
+|默认值| false |
+|改后生效方式| 重启服务生效 |
+
+* rpc\_selector\_thread\_count
+
+| 名字 | rpc\_selector\_thread\_count |
+|:------:|:-----------------------------|
+| 描述 | rpc 选择器线程数量 |
+| 类型 | int |
+| 默认值 | 1 |
+| 改后生效方式 | 重启服务生效 |
+
+* rpc\_min\_concurrent\_client\_num
+
+| 名字 | rpc\_min\_concurrent\_client\_num |
+|:------:|:----------------------------------|
+| 描述 | 最小连接数 |
+| 类型 | Short Int : [0,65535] |
+| 默认值 | 1 |
+| 改后生效方式 | 重启服务生效 |
* rpc\_max\_concurrent\_client\_num
-|名字| rpc\_max\_concurrent\_client\_num |
-|:---:|:---|
-|描述| 最大连接数。|
-|类型| Short Int : [0,65535] |
-|默认值| 65535 |
-|改后生效方式|重启服务生效|
+| 名字 | rpc\_max\_concurrent\_client\_num |
+|:------:|:----------------------------------|
+| 描述 | 最大连接数 |
+| 类型 | Short Int : [0,65535] |
+| 默认值 | 65535 |
+| 改后生效方式 | 重启服务生效 |
* thrift\_max\_frame\_size
@@ -165,30 +185,30 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB
* mpp\_data\_exchange\_core\_pool\_size
-|名字| mpp\_data\_exchange\_core\_pool\_size |
-|:---:|:---|
-|描述| MPP 数据交换线程池核心线程数 |
-|类型| int |
-|默认值| 1 |
-|改后生效方式|重启服务生效|
+| 名字 | mpp\_data\_exchange\_core\_pool\_size |
+|:------:|:--------------------------------------|
+| 描述 | MPP 数据交换线程池核心线程数 |
+| 类型 | int |
+| 默认值 | 10 |
+| 改后生效方式 | 重启服务生效 |
* mpp\_data\_exchange\_max\_pool\_size
|名字| mpp\_data\_exchange\_max\_pool\_size |
-|:---:|:---|
+|:---:|:--|
|描述| MPP 数据交换线程池最大线程数 |
|类型| int |
-|默认值| 5 |
+|默认值| 10 |
|改后生效方式|重启服务生效|
* mpp\_data\_exchange\_keep\_alive\_time\_in\_ms
-|名字| mpp\_data\_exchange\_keep\_alive\_time\_in\_ms |
-|:---:|:---|
-|描述| MPP 数据交换最大等待时间 |
-|类型| long |
-|默认值| 1000 |
-|改后生效方式|重启服务生效|
+| 名字 | mpp\_data\_exchange\_keep\_alive\_time\_in\_ms |
+|:------:|:-----------------------------------------------|
+| 描述 | MPP 数据交换最大等待时间 |
+| 类型 | int |
+| 默认值 | 1000 |
+| 改后生效方式 | 重启服务生效 |
* driver\_task\_execution\_time\_slice\_in\_ms
@@ -219,50 +239,50 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB
### DataNode 内部服务参数
-* internal\_address
+* dn\_internal\_address
-|名字| internal\_address |
+|名字| dn\_internal\_address |
|:---:|:---|
|描述| DataNode 内网通信地址 |
|类型| string |
|默认值| 127.0.0.1 |
|改后生效方式|重启服务生效|
-* internal\_port
+* dn\_internal\_port
-|名字| internal\_address |
-|:---:|:---|
-|描述| DataNode 内网通信端口 |
-|类型| int |
-|默认值| 9003 |
-|改后生效方式|重启服务生效|
+|名字| dn\_internal\_port |
+|:---:|:-------------------|
+|描述| DataNode 内网通信端口 |
+|类型| int |
+|默认值| 9003 |
+|改后生效方式| 重启服务生效 |
-* data\_region\_consensus\_port
+* dn\_data\_region\_consensus\_port
-|名字| data\_region\_consensus\_port |
+|名字| dn\_data\_region\_consensus\_port |
|:---:|:---|
|描述| DataNode 数据副本的共识协议通信端口 |
|类型| int |
|默认值| 40010 |
|改后生效方式|重启服务生效|
-* schema\_region\_consensus\_port
+* dn\_schema\_region\_consensus\_port
-|名字| schema\_region\_consensus\_port |
+|名字| dn\_schema\_region\_consensus\_port |
|:---:|:---|
|描述| DataNode 元数据副本的共识协议通信端口 |
|类型| int |
|默认值| 50010 |
|改后生效方式|重启服务生效|
-* target\_config\_nodes
+* dn\_target\_config\_node\_list
-|名字| target\_config\_nodes |
-|:---:|:---|
+|名字| dn\_target\_config\_node\_list |
+|:---:|:------------------------------------|
|描述| ConfigNode 地址，DataNode 启动时通过此地址加入集群 |
-|类型| String |
-|默认值| 127.0.0.1:22277 |
-|改后生效方式|重启服务生效|
+|类型| String |
+|默认值| 127.0.0.1:22277 |
+|改后生效方式| 重启服务生效 |
### InfluxDB 协议适配器配置
@@ -344,41 +364,41 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB
### 目录配置
-* system\_dir
+* dn\_system\_dir
-|名字| system\_dir |
-|:---:|:---|
-|描述| IoTDB 元数据存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。|
-|类型| String |
-|默认值| data/system（Windows：data\\system） |
-|改后生效方式|触发生效|
+| 名字 | dn\_system\_dir |
+|:------:|:--------------------------------------------------------------------|
+| 描述 | IoTDB 元数据存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。 |
+| 类型 | String |
+| 默认值 | data/datanode/system（Windows：data\\datanode\\system） |
+| 改后生效方式 | 触发生效 |
-* data\_dirs
+* dn\_data\_dirs
-|名字| data\_dirs |
-|:---:|:---|
-|描述| IoTDB 数据存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。|
-|类型| String |
-|默认值| data/data（Windows：data\\data） |
-|改后生效方式|触发生效|
+| 名字 | dn\_data\_dirs |
+|:------:|:-------------------------------------------------------------------|
+| 描述 | IoTDB 数据存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。 |
+| 类型 | String |
+| 默认值 | data/datanode/data（Windows：data\\datanode\\data） |
+| 改后生效方式 | 触发生效 |
-* multi\_dir\_strategy
+* dn\_multi\_dir\_strategy
-|名字| multi\_dir\_strategy |
-|:---:|:---|
-|描述| IoTDB 在 data\_dirs 中为 TsFile 选择目录时采用的策略。可使用简单类名或类名全称。系统提供以下三种策略：<br>1. SequenceStrategy：IoTDB 按顺序选择目录，依次遍历 data\_dirs 中的所有目录，并不断轮循；<br>2. MaxDiskUsableSpaceFirstStrategy：IoTDB 优先选择 data\_dirs 中对应磁盘空余空间最大的目录；<br>3. MinFolderOccupiedSpaceFirstStrategy：IoTDB 优先选择 data\_dirs 中已使用空间最小的目录；<br>4. UserDefineStrategyPackage（用户自定义策略）<br>您可以通过以下方法完成用户自定义策略：<br>1. 继承 org.apache.iotdb.db.conf.directories.strategy 类并实现自身的 Strategy 方法；<br>2. 将实现的类的完整类名（包名加类名，UserDefineStrategyPackage）填写到该配置项；<br>3 [...]
-|类型| String |
-|默认值| MaxDiskUsableSpaceFirstStrategy |
-|改后生效方式|触发生效|
+| 名字 | dn\_multi\_dir\_strategy [...]
+|:------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
+| 描述 | IoTDB 在 data\_dirs 中为 TsFile 选择目录时采用的策略。可使用简单类名或类名全称。系统提供以下三种策略：<br>1. SequenceStrategy：IoTDB 按顺序选择目录，依次遍历 data\_dirs 中的所有目录，并不断轮循；<br>2. MaxDiskUsableSpaceFirstStrategy：IoTDB 优先选择 data\_dirs 中对应磁盘空余空间最大的目录；<br>3. MinFolderOccupiedSpaceFirstStrategy：IoTDB 优先选择 data\_dirs 中已使用空间最小的目录；<br>4. UserDefineStrategyPackage（用户自定义策略）<br>您可以通过以下方法完成用户自定义策略：<br>1. 继承 org.apache.iotdb.db.conf.directories.strategy 类并实现自身的 Strategy 方法；<br>2. 将实现的类的完整类名（包名加类名，UserDefineStrategyPackage）填写到该配置项 [...]
+| 类型 | String [...]
+| 默认值 | MaxDiskUsableSpaceFirstStrategy [...]
+| 改后生效方式 | 触发生效 [...]
-* wal\_dir
+* dn\_wal\_dir
-|名字| wal\_dir |
-|:---:|:---|
-|描述| IoTDB 写前日志存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。|
-|类型| String |
-|默认值| data/wal（Windows：data\\wal） |
-|改后生效方式|触发生效|
+| 名字 | dn\_wal\_dir |
+|:------:|:---------------------------------------------------------------------|
+| 描述 | IoTDB 写前日志存储路径，默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关，建议使用绝对路径。 |
+| 类型 | String |
+| 默认值 | data/datanode/wal（Windows：data\\datanode\\wal） |
+| 改后生效方式 | 触发生效 |
* tsfile\_storage\_fs
@@ -1218,14 +1238,14 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB
|默认值| true |
|改后生效方式|重启服务生效|
-* tracing\_dir
+* dn\_tracing\_dir
-|名字| tracing\_dir |
-|:---:|:--------------------------|
-|描述| 取消注释用以下字段来配置 tracing 根目录。 |
-|类型| String |
-|默认值| data/tracing(Windows:data\\tracing) |
-|改后生效方式| 重启服务生效 |
+| 名字 | dn\_tracing\_dir |
+|:------:|:-------------------------------------------------------|
+| 描述 | 取消注释用以下字段来配置 tracing 根目录。 |
+| 类型 | String |
+| 默认值 | data/datanode/tracing(Windows:data\\datanode\\tracing) |
+| 改后生效方式 | 重启服务生效 |
### 水印模块配置