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/23 09:00:01 UTC
[iotdb] branch master updated: [IOTDB-5012] Update Deployment and User doc for cluster V1.0 (#8091)
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 f3f267b2a9 [IOTDB-5012] Update Deployment and User doc for cluster V1.0 (#8091)
f3f267b2a9 is described below
commit f3f267b2a9bbff08b61db9c15fe7999a38b879c8
Author: Itami Sho <42...@users.noreply.github.com>
AuthorDate: Wed Nov 23 16:59:55 2022 +0800
[IOTDB-5012] Update Deployment and User doc for cluster V1.0 (#8091)
---
docs/UserGuide/Cluster/Cluster-Concept.md | 15 ++
docs/UserGuide/Cluster/Cluster-Setup.md | 228 +++++++++++---------
.../Maintenance-Tools/Maintenance-Command.md | 234 ++++++++++-----------
docs/zh/UserGuide/Cluster/Cluster-Concept.md | 15 ++
docs/zh/UserGuide/Cluster/Cluster-Setup.md | 231 +++++++++++---------
.../Maintenance-Tools/Maintenance-Command.md | 229 +++++++++-----------
.../db/mpp/common/header/ColumnHeaderConstant.java | 6 +-
7 files changed, 496 insertions(+), 462 deletions(-)
diff --git a/docs/UserGuide/Cluster/Cluster-Concept.md b/docs/UserGuide/Cluster/Cluster-Concept.md
index 6d3afb1a56..b54766df57 100644
--- a/docs/UserGuide/Cluster/Cluster-Concept.md
+++ b/docs/UserGuide/Cluster/Cluster-Concept.md
@@ -35,6 +35,21 @@ DataNode stores the data and schema of cluster, which manages multiple data regi
Client could only connect to the DataNode for operation.
+### Concepts
+
+| Concept | Type | Description |
+|:------------------|:---------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
+| ConfigNode | node role | Configuration node, which manages cluster node information and partition information, monitors cluster status, controls load balancing |
+| DataNode | node role | Data node, which manages data and meta data |
+| Database | meta data | Database, data are isolated physically from different databases |
+| DeviceId | device id | The full path from root to the penultimate level in the metadata tree represents a device id |
+| SeriesSlot | series partition slot | Each database has a fixed number of series slots, containing the schemas of series |
+| SeriesTimeSlot | a time partition of a SeriesSlot | All series of a time partition in a series slot |
+| DataRegion | data region | A collection of multiple SeriesTimeSlots |
+| DataRegionGroup | logical concept | The number of DataRegions contained in group is the number of data replication, it manages the same data, and back up each other |
+| SchemaRegion | schema region | A collection of multiple SeriesSlot |
+| SchemaRegionGroup | logical concept | The number of SchemaRegions contained in group is the number of schema replication, it manages the same schema data, and back up each other |
+
## Characteristics of Cluster
* Native Cluster Architecture
diff --git a/docs/UserGuide/Cluster/Cluster-Setup.md b/docs/UserGuide/Cluster/Cluster-Setup.md
index 5ae4d0a3dd..edeece8026 100644
--- a/docs/UserGuide/Cluster/Cluster-Setup.md
+++ b/docs/UserGuide/Cluster/Cluster-Setup.md
@@ -21,7 +21,7 @@
## Cluster Setup
-This article is the setup process of IoTDB Cluster (0.14.0-preview1).
+This article is the setup process of IoTDB Cluster (1.0.0).
## Environments
@@ -48,7 +48,7 @@ git clone https://github.com/apache/iotdb.git
The default branch is master, you should checkout to the release tag:
```
-git checkout v0.14.0-preview1
+git checkout v1.0.0
```
Under the source root folder:
@@ -61,13 +61,16 @@ Then you will get the binary distribution under **distribution/target**, in whic
## Binary Distribution Content
-| **Folder** | **Description** |
-|-------------------------|-------------------------------------------------------------------------------------|
-| confignode | Contains start/stop/remove shell, configurations, logs, data of ConfigNode |
-| datanode | Contains start/stop/remove shell, configurations, logs, data of DataNode, cli shell |
-| grafana-metrics-example | Grafana metric page module |
-| lib | Jar files folder |
-| tools | System tools |
+| **Folder** | **Description** |
+|-------------------------|--------------------------------------------------------------------------------------------|
+| conf | Configuration files folder, contains configuration files of ConfigNode and DataNode |
+| data | Data files folder, contains data files of ConfigNode and DataNode | |
+| grafana-metrics-example | Grafana metric page module |
+| lib | Jar files folder |
+| licenses | Licenses files folder |
+| logs | Logs files folder, contains logs files of ConfigNode and DataNode |
+| sbin | Shell files folder, contains start/stop/remove shell of ConfigNode and DataNode, cli shell |
+| tools | System tools |
## Start the Cluster
@@ -82,38 +85,45 @@ The total process are three steps:
### Start the first ConfigNode
-Please set the important parameters in iotdb-confignode.properties:
+Please set the important parameters in conf/iotdb-confignode.properties and conf/iotdb-common.properties:
-| **Configuration** | **Description** |
-|--------------------------------------------|----------------------------------------------------------------------------------------------|
-| internal\_address | Internal rpc service address of ConfigNode |
-| internal\_port | Internal rpc service address of ConfigNode |
-| consensus\_port | ConfigNode replication consensus protocol communication port |
-| target\_config\_nodes | Target ConfigNode address, if the current is the first ConfigNode, then set its address:port |
-| data\_replication\_factor | Data replication factor, no more than DataNode number |
-| data\_region\_consensus\_protocol\_class | Consensus protocol of data replicas |
-| schema\_replication\_factor | Schema replication factor, no more than DataNode number |
-| schema\_region\_consensus\_protocol\_class | Consensus protocol of schema replicas |
+iotdb-confignode.properties:
+
+| **Configuration** | **Description** |
+|--------------------------------|----------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Target ConfigNode address, if the current is the first ConfigNode, then set its address:port |
+
+iotdb-common.properties:
+
+| **Configuration** | **Description** |
+|--------------------------------------------|------------------------------------------------------------------------------------------------------|
+| data\_replication\_factor | Data replication factor, no more than DataNode number |
+| data\_region\_consensus\_protocol\_class | Consensus protocol of data replicas |
+| schema\_replication\_factor | Schema replication factor, no more than DataNode number |
+| schema\_region\_consensus\_protocol\_class | Consensus protocol of schema replicas |
Start on Linux:
```
# Foreground
-./confignode/sbin/start-confignode.sh
+./sbin/start-confignode.sh
# Background
-nohup ./confignode/sbin/start-confignode.sh >/dev/null 2>&1 &
+nohup ./sbin/start-confignode.sh >/dev/null 2>&1 &
```
Start on Windows:
```
-confignode\sbin\start-confignode.bat
+sbin\start-confignode.bat
```
More details [ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
### Add ConfigNode (Optional)
-This will add the replication factor of ConfigNode, except for the port couldn't conflict, make sure other configurations are the same with existing ConfigNode in Cluster.
+This will add the replication factor of ConfigNode, except for the ports that couldn't conflict with, make sure other configurations are the same with existing ConfigNode in Cluster, and set parameter cn\_target\_config\_nodes\_list as an active ConfigNode in Cluster.
The adding ConfigNode also use the start-confignode.sh/bat.
@@ -121,38 +131,38 @@ The adding ConfigNode also use the start-confignode.sh/bat.
You could add any number of DataNode.
-Please set the important parameters in iotdb-datanode.properties.
+Please set the important parameters in iotdb-datanode.properties:
-| **Configuration** | **Description** |
-|---------------------------------|--------------------------------------------------|
-| rpc\_address | Client RPC Service address |
-| rpc\_port | Client RPC Service port |
-| internal\_address | Control flow address of DataNode inside cluster |
-| internal\_port | Control flow port of DataNode inside cluster |
-| mpp\_data\_exchange\_port | Data flow port of DataNode inside cluster |
-| data\_region\_consensus\_port | Data replicas communication port for consensus |
-| schema\_region\_consensus\_port | Schema replicas communication port for consensus |
-| target\_config\_nodes | Running ConfigNode of the Cluster |
+| **Configuration** | **Description** |
+|-------------------------------------|--------------------------------------------------|
+| dn\_rpc\_address | Client RPC Service address |
+| dn\_rpc\_port | Client RPC Service port |
+| dn\_internal\_address | Control flow address of DataNode inside cluster |
+| dn\_internal\_port | Control flow port of DataNode inside cluster |
+| dn\_mpp\_data\_exchange\_port | Data flow port of DataNode inside cluster |
+| dn\_data\_region\_consensus\_port | Data replicas communication port for consensus |
+| dn\_schema\_region\_consensus\_port | Schema replicas communication port for consensus |
+| dn\_target\_config\_node\_list | Running ConfigNode of the Cluster |
Start on Linux:
```
# Foreground
-./datanode/sbin/start-datanode.sh
+./sbin/start-datanode.sh
# Background
-nohup ./datanode/sbin/start-datanode.sh >/dev/null 2>&1 &
+nohup ./sbin/start-datanode.sh >/dev/null 2>&1 &
```
Start on Windows:
```
-datanode\sbin\start-datanode.bat
+sbin\start-datanode.bat
```
More details [DataNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html).
### Start Cli
-Cli is in datanode/sbin folder.
+Cli shell is in sbin folder.
Start on Linux:
```
@@ -168,33 +178,45 @@ datanode\sbin\start-cli.bat
### Remove ConfigNode
-Execute the remove-confignode shell on an active ConfigNode.
+Execute the remove-confignode shell on an active ConfigNode, and make sure that there is at least one active ConfigNode in Cluster after removing.
Remove on Linux:
```
+# Remove the ConfigNode with confignode_id
./confignode/sbin/remove-confignode.sh <confignode_id>
+
+# Remove the ConfigNode with address:port
./confignode/sbin/remove-confignode.sh <internal_address>:<internal_port>
```
Remove on Windows:
```
+# Remove the ConfigNode with confignode_id
confignode\sbin\remove-confignode.bat <confignode_id>
+
+# Remove the ConfigNode with address:port
confignode\sbin\remove-confignode.bat <internal_address>:<internal_port>
```
### Remove DataNode
-Execute the remove-datanode shell on an active DataNode.
+Execute the remove-datanode shell on an active, and make sure that there are no less than the number of data/schema_replication_factor DataNodes in Cluster after removing.
Remove on Linux:
```
+# Remove the DataNode with datanode_id
./datanode/sbin/remove-datanode.sh <datanode_id>
+
+# Remove the DataNode with rpc address:port
./datanode/sbin/remove-datanode.sh <rpc_address>:<rpc_port>
```
Remove on Windows:
```
+# Remove the DataNode with datanode_id
datanode\sbin\remove-datanode.bat <datanode_id>
+
+# Remove the DataNode with rpc address:port
datanode\sbin\remove-datanode.bat <rpc_address>:<rpc_port>
```
@@ -205,22 +227,22 @@ illustrate how to start, expand, and shrink a IoTDB Cluster.
### 1. Prepare the Start Environment
-Unzip the apache-iotdb-0.14.0-preview1-all-bin.zip file to cluster0 folder.
+Unzip the apache-iotdb-1.0.0-all-bin.zip file to cluster0 folder.
### 2. Starting a Minimum Cluster
Starting the Cluster version with one ConfigNode and one DataNode(1C1D),
the default number of replica is one.
```
-./cluster0/confignode/sbin/start-confignode.sh
-./cluster0/datanode/sbin/start-datanode.sh
+./cluster0/sbin/start-confignode.sh
+./cluster0/sbin/start-datanode.sh
```
### 3. Verify the Minimum Cluster
+ The minimum cluster is successfully started. Start the Cli for verification.
```
-./cluster0/datanode/sbin/start-cli.sh
+./cluster0/sbin/start-cli.sh
```
+ Execute the [show cluster](https://iotdb.apache.org/UserGuide/Master/Maintenance-Tools/Maintenance-Command.html#show-all-node-information)
@@ -230,7 +252,7 @@ IoTDB> show cluster
+------+----------+-------+---------------+------------+
|NodeID| NodeType| Status|InternalAddress|InternalPort|
+------+----------+-------+---------------+------------+
-| 0|ConfigNode|Running| 0.0.0.0| 22277|
+| 0|ConfigNode|Running| 127.0.0.1| 22277|
| 1| DataNode|Running| 127.0.0.1| 9003|
+------+----------+-------+---------------+------------+
Total line number = 2
@@ -239,57 +261,57 @@ It costs 0.160s
### 4. Prepare the Expanding Environment
-Unzip the apache-iotdb-0.14.0-preview1-all-bin.zip file to cluster1 and cluster2 folder.
+Unzip the apache-iotdb-1.0.0-all-bin.zip file to cluster1 and cluster2 folder.
### 5. Modify the Node Configuration file
For folder cluster1:
-+ Modify ConfigNode address:
-
-| **configuration item** | **value** |
-|------------------------|---------------|
-| internal\_address | 0.0.0.0 |
-| internal\_port | 22279 |
-| consensus\_port | 22280 |
-| target\_config\_nodes | 0.0.0.0:22277 |
-
-+ Modify DataNode address:
-
-| **configuration item** | **value** |
-|---------------------------------|-----------------|
-| rpc\_address | 0.0.0.0 |
-| rpc\_port | 6668 |
-| internal\_address | 127.0.0.1 |
-| internal\_port | 9004 |
-| mpp\_data\_exchange\_port | 8778 |
-| data\_region\_consensus\_port | 40011 |
-| schema\_region\_consensus\_port | 50011 |
-| target\_config\_nodes | 127.0.0.1:22277 |
-
-For folder cluster1:
-
-+ Modify ConfigNode address:
-
-| **configuration item** | **value** |
-|------------------------|---------------|
-| internal\_address | 0.0.0.0 |
-| internal\_port | 22281 |
-| consensus\_port | 22282 |
-| target\_config\_nodes | 0.0.0.0:22277 |
-
-+ Modify DataNode address:
-
-| **configuration item** | **value** |
-|---------------------------------|-----------------|
-| rpc\_address | 0.0.0.0 |
-| rpc\_port | 6669 |
-| internal\_address | 127.0.0.1 |
-| internal\_port | 9005 |
-| mpp\_data\_exchange\_port | 8779 |
-| data\_region\_consensus\_port | 40012 |
-| schema\_region\_consensus\_port | 50012 |
-| target\_config\_nodes | 127.0.0.1:22277 |
++ Modify ConfigNode configurations:
+
+| **configuration item** | **value** |
+|--------------------------------|-----------------|
+| cn\_internal\_address | 127.0.0.1 |
+| cn\_internal\_port | 22279 |
+| cn\_consensus\_port | 22280 |
+| cn\_target\_config\_node\_list | 127.0.0.1:22277 |
+
++ Modify DataNode configurations:
+
+| **configuration item** | **value** |
+|-------------------------------------|-----------------|
+| dn\_rpc\_address | 127.0.0.1 |
+| dn\_rpc\_port | 6668 |
+| dn\_internal\_address | 127.0.0.1 |
+| dn\_internal\_port | 9004 |
+| dn\_mpp\_data\_exchange\_port | 8778 |
+| dn\_data\_region\_consensus\_port | 40011 |
+| dn\_schema\_region\_consensus\_port | 50011 |
+| dn\_target\_config\_node\_list | 127.0.0.1:22277 |
+
+For folder cluster2:
+
++ Modify ConfigNode configurations:
+
+| **configuration item** | **value** |
+|--------------------------------|-----------------|
+| cn\_internal\_address | 127.0.0.1 |
+| cn\_internal\_port | 22281 |
+| cn\_consensus\_port | 22282 |
+| cn\_target\_config\_node\_list | 127.0.0.1:22277 |
+
++ Modify DataNode configurations:
+
+| **configuration item** | **value** |
+|-------------------------------------|-----------------|
+| dn\_rpc\_address | 127.0.0.1 |
+| dn\_rpc\_port | 6669 |
+| dn\_internal\_address | 127.0.0.1 |
+| dn\_internal\_port | 9005 |
+| dn\_mpp\_data\_exchange\_port | 8779 |
+| dn\_data\_region\_consensus\_port | 40012 |
+| dn\_schema\_region\_consensus\_port | 50012 |
+| dn\_target\_config\_node\_list | 127.0.0.1:22277 |
### 6. Expanding the Cluster
@@ -297,10 +319,10 @@ Expanding the Cluster to three ConfigNode and three DataNode(3C3D).
The following commands can be executed in no particular order.
```
-./cluster1/confignode/sbin/start-confignode.sh
-./cluster1/datanode/sbin/start-datanode.sh
-./cluster2/confignode/sbin/start-confignode.sh
-./cluster2/datanode/sbin/start-datanode.sh
+./cluster1/sbin/start-confignode.sh
+./cluster1/sbin/start-datanode.sh
+./cluster2/sbin/start-confignode.sh
+./cluster2/sbin/start-datanode.sh
```
### 7. Verify Cluster expansion
@@ -311,9 +333,9 @@ IoTDB> show cluster
+------+----------+-------+---------------+------------+
|NodeID| NodeType| Status|InternalAddress|InternalPort|
+------+----------+-------+---------------+------------+
-| 0|ConfigNode|Running| 0.0.0.0| 22277|
-| 2|ConfigNode|Running| 0.0.0.0| 22279|
-| 3|ConfigNode|Running| 0.0.0.0| 22281|
+| 0|ConfigNode|Running| 127.0.0.1| 22277|
+| 2|ConfigNode|Running| 127.0.0.1| 22279|
+| 3|ConfigNode|Running| 127.0.0.1| 22281|
| 1| DataNode|Running| 127.0.0.1| 9003|
| 4| DataNode|Running| 127.0.0.1| 9004|
| 5| DataNode|Running| 127.0.0.1| 9005|
@@ -326,12 +348,12 @@ It costs 0.012s
+ Remove a ConfigNode:
```
-./cluster0/confignode/sbin/remove-confignode.sh 127.0.0.1:22279
+./cluster0/sbin/remove-confignode.sh 127.0.0.1:22279
```
+ Remove a DataNode:
```
-./cluster0/datanode/sbin/remove-datanode.sh 127.0.0.1:6668
+./cluster0/sbin/remove-datanode.sh 127.0.0.1:6668
```
### 9. Verify Cluster shrinkage
@@ -342,8 +364,8 @@ IoTDB> show cluster
+------+----------+-------+---------------+------------+
|NodeID| NodeType| Status|InternalAddress|InternalPort|
+------+----------+-------+---------------+------------+
-| 0|ConfigNode|Running| 0.0.0.0| 22277|
-| 3|ConfigNode|Running| 0.0.0.0| 22281|
+| 0|ConfigNode|Running| 127.0.0.1| 22277|
+| 3|ConfigNode|Running| 127.0.0.1| 22281|
| 1| DataNode|Running| 127.0.0.1| 9003|
| 5| DataNode|Running| 127.0.0.1| 9005|
+------+----------+-------+---------------+------------+
diff --git a/docs/UserGuide/Maintenance-Tools/Maintenance-Command.md b/docs/UserGuide/Maintenance-Tools/Maintenance-Command.md
index 55c226b432..61368da459 100644
--- a/docs/UserGuide/Maintenance-Tools/Maintenance-Command.md
+++ b/docs/UserGuide/Maintenance-Tools/Maintenance-Command.md
@@ -147,45 +147,25 @@ IoTDB> create timeseries root.sg.d2.s1 with datatype=BOOLEAN,encoding=PLAIN
Msg: The statement is executed successfully.
IoTDB> create timeseries root.ln.d1.s1 with datatype=BOOLEAN,encoding=PLAIN
Msg: The statement is executed successfully.
-IoTDB> show regions
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|RegionId| Type|Status| Database|Series Slots|Time Slots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-| 0|SchemaRegion| Up| root.sg| 2| 0| 1|127.0.0.1| 6667|Leader|
-| 1|SchemaRegion| Up| root.ln| 1| 0| 2|127.0.0.1| 6668|Leader|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-Total line number = 2
-It costs 0.013s
-
IoTDB> show datanodes
-+------+-------+---------+-------+-------------+---------------+
-|NodeID| Status| Host|RpcPort|DataRegionNum|SchemaRegionNum|
-+------+-------+---------+-------+-------------+---------------+
-| 1|Running|127.0.0.1| 6667| 0| 1|
-| 2|Running|127.0.0.1| 6668| 0| 1|
-+------+-------+---------+-------+-------------+---------------+
++------+-------+----------+-------+-------------+---------------+
+|NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum|
++------+-------+----------+-------+-------------+---------------+
+| 1|Running| 127.0.0.1| 6667| 0| 1|
+| 2|Running| 127.0.0.1| 6668| 0| 1|
++------+-------+----------+-------+-------------+---------------+
Total line number = 2
It costs 0.007s
IoTDB> insert into root.ln.d1(timestamp,s1) values(1,true)
Msg: The statement is executed successfully.
-IoTDB> show regions
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|RegionId| Type|Status| Database|Series Slots|Time Slots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-| 0|SchemaRegion| Up| root.sg| 2| 0| 1|127.0.0.1| 6667|Leader|
-| 1|SchemaRegion| Up| root.ln| 1| 0| 2|127.0.0.1| 6668|Leader|
-| 2| DataRegion| Up| root.ln| 1| 1| 1|127.0.0.1| 6667|Leader|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-Total line number = 3
-It costs 0.008s
IoTDB> show datanodes
-+------+-------+---------+-------+-------------+---------------+
-|NodeID| Status| Host|RpcPort|DataRegionNum|SchemaRegionNum|
-+------+-------+---------+-------+-------------+---------------+
-| 1|Running|127.0.0.1| 6667| 1| 1|
-| 2|Running|127.0.0.1| 6668| 0| 1|
-+------+-------+---------+-------+-------------+---------------+
++------+-------+----------+-------+-------------+---------------+
+|NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum|
++------+-------+----------+-------+-------------+---------------+
+| 1|Running| 127.0.0.1| 6667| 1| 1|
+| 2|Running| 127.0.0.1| 6668| 0| 1|
++------+-------+----------+-------+-------------+---------------+
Total line number = 2
It costs 0.006s
```
@@ -210,13 +190,13 @@ Eg :
```
IoTDB> show confignodes
-+------+-------+-------+------------+--------+
-|NodeID| Status| Host|InternalPort| Role|
-+------+-------+-------+------------+--------+
-| 0|Running|0.0.0.0| 22277| Leader|
-| 1|Running|0.0.0.0| 22279|Follower|
-| 2|Running|0.0.0.0| 22281|Follower|
-+------+-------+-------+------------+--------+
++------+-------+---------------+------------+--------+
+|NodeID| Status|InternalAddress|InternalPort| Role|
++------+-------+---------------+------------+--------+
+| 0|Running| 127.0.0.1| 22277| Leader|
+| 1|Running| 127.0.0.1| 22279|Follower|
+| 2|Running| 127.0.0.1| 22281|Follower|
++------+-------+---------------+------------+--------+
Total line number = 3
It costs 0.030s
```
@@ -242,9 +222,9 @@ IoTDB> show cluster
+------+----------+-------+---------------+------------+
|NodeID| NodeType| Status|InternalAddress|InternalPort|
+------+----------+-------+---------------+------------+
-| 0|ConfigNode|Running| 0.0.0.0| 22277|
-| 1|ConfigNode|Running| 0.0.0.0| 22279|
-| 2|ConfigNode|Running| 0.0.0.0| 22281|
+| 0|ConfigNode|Running| 127.0.0.1| 22277|
+| 1|ConfigNode|Running| 127.0.0.1| 22279|
+| 2|ConfigNode|Running| 127.0.0.1| 22281|
| 3| DataNode|Running| 127.0.0.1| 9003|
| 4| DataNode|Running| 127.0.0.1| 9005|
| 5| DataNode|Running| 127.0.0.1| 9007|
@@ -283,9 +263,9 @@ IoTDB> show cluster
+------+----------+-------+---------------+------------+
|NodeID| NodeType| Status|InternalAddress|InternalPort|
+------+----------+-------+---------------+------------+
-| 0|ConfigNode|Running| 0.0.0.0| 22277|
-| 1|ConfigNode|Unknown| 0.0.0.0| 22279|
-| 2|ConfigNode|Running| 0.0.0.0| 22281|
+| 0|ConfigNode|Running| 127.0.0.1| 22277|
+| 1|ConfigNode|Unknown| 127.0.0.1| 22279|
+| 2|ConfigNode|Running| 127.0.0.1| 22281|
| 3| DataNode|Running| 127.0.0.1| 9003|
| 4| DataNode|Running| 127.0.0.1| 9005|
| 5| DataNode|Running| 127.0.0.1| 9007|
@@ -310,22 +290,22 @@ Currently, IoTDB supports Region query using the following SQL：
Show distribution of all Regions:
```
IoTDB> show regions
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0| DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0| DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0| DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 1|0.0.0.0| 6667| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 2|0.0.0.0| 6668|Follower|
-| 2| DataRegion|Running| root.sg2| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 2|0.0.0.0| 6668| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|
+| 2| DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 12
It costs 0.165s
```
@@ -333,30 +313,30 @@ It costs 0.165s
Show the distribution of SchemaRegions or DataRegions:
```
IoTDB> show data regions
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0| DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0| DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0| DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 2| DataRegion|Running| root.sg2| 1| 1| 1|0.0.0.0| 6667| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 2|0.0.0.0| 6668|Follower|
-| 2| DataRegion|Running| root.sg2| 1| 1| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|
+| 2| DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.011s
IoTDB> show schema regions
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 2|0.0.0.0| 6668| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.012s
```
@@ -365,64 +345,64 @@ Show Region distribution of specified StorageGroups:
```
IoTDB> show regions of database root.sg1
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0| DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0| DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0| DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+-- -----+-----------+---------+----------+----------+-------+--------+
+| 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.007s
IoTDB> show regions of database root.sg1, root.sg2
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0| DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0| DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0| DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 1|0.0.0.0| 6667| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 2|0.0.0.0| 6668|Follower|
-| 2| DataRegion|Running| root.sg2| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 2|0.0.0.0| 6668| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|
+| 2| DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 12
It costs 0.009s
IoTDB> show data regions of database root.sg1, root.sg2
-+--------+----------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+----------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0|DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0|DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0|DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 2|DataRegion|Running| root.sg2| 1| 1| 1|0.0.0.0| 6667| Leader|
-| 2|DataRegion|Running| root.sg2| 1| 1| 2|0.0.0.0| 6668|Follower|
-| 2|DataRegion|Running| root.sg2| 1| 1| 3|0.0.0.0| 6669|Follower|
-+--------+----------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+----------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+----------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 0|DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0|DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0|DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 2|DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|
+| 2|DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|
+| 2|DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|
++--------+----------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.007s
IoTDB> show schema regions of database root.sg1, root.sg2
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 2|0.0.0.0| 6668| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.009s
```
diff --git a/docs/zh/UserGuide/Cluster/Cluster-Concept.md b/docs/zh/UserGuide/Cluster/Cluster-Concept.md
index fdb67e3e93..81c0db45ee 100644
--- a/docs/zh/UserGuide/Cluster/Cluster-Concept.md
+++ b/docs/zh/UserGuide/Cluster/Cluster-Concept.md
@@ -35,6 +35,21 @@ DataNode 是集群的数据节点，管理多个数据分片、元数据分片
Client 只能通过 DataNode 进行数据读写。
+### 名词解释
+
+| 名词 | 类型 | 解释 |
+|:------------------|:--------------|:-------------------------------------|
+| ConfigNode | 节点角色 | 配置节点，管理集群节点信息、分区信息，监控集群状态、控制负载均衡 |
+| DataNode | 节点角色 | 数据节点，管理数据、元数据 |
+| Database | 元数据 | 数据库，不同数据库的数据物理隔离 |
+| DeviceId | 设备名 | 元数据树中从 root 到倒数第二级的全路径表示一个设备名 |
+| SeriesSlot | 序列分区槽 | 每个 Database 会对应固定个数的序列槽，包含其中序列的元数据 |
+| SeriesTimeSlot | 一个序列槽的一个时间分区槽 | 对应一个 SeriesSlot 内所有序列一个时间分区的数据 |
+| DataRegion | 一组数据分区 | 多个 SeriesTimeSlot 的集合 |
+| DataRegionGroup | 逻辑概念 | 包含数据副本数个 DataRegion，管理相同的数据，互为备份 |
+| SchemaRegion | 一组元数据分区 | 多个 SeriesSlot 的集合 |
+| SchemaRegionGroup | 逻辑概念 | 包含元数据副本数个 SchemaRegion，管理相同的元数据，互为备份 |
+
## 集群特点
* 原生分布式
diff --git a/docs/zh/UserGuide/Cluster/Cluster-Setup.md b/docs/zh/UserGuide/Cluster/Cluster-Setup.md
index ef7d4960b1..c83421ec4b 100644
--- a/docs/zh/UserGuide/Cluster/Cluster-Setup.md
+++ b/docs/zh/UserGuide/Cluster/Cluster-Setup.md
@@ -21,7 +21,7 @@
## 集群设置
-本文档为 IoTDB 集群版（0.14.0-preview1）启动教程。
+本文档为 IoTDB 集群版（1.0.0）启动教程。
## 安装环境
@@ -48,7 +48,7 @@ git clone https://github.com/apache/iotdb.git
默认分支为 master 分支，你可以切换到发布版本的 tag，例如：
```
-git checkout v0.14.0-preview1
+git checkout v1.0.0
```
在 IoTDB 根目录下:
@@ -61,13 +61,16 @@ mvn clean package -pl distribution -am -DskipTests
## 安装包说明
-| **目录** | **说明** |
-|-------------------------|-----------------------------------------|
-| confignode | 包含 ConfigNode 的启停移除脚本、配置文件、日志、数据 |
-| datanode | 包含 DataNode 的启停移除脚本、配置文件、日志、数据；Cli的启动脚本 |
-| grafana-metrics-example | Grafana 监控界面模板 |
-| lib | 库文件目录 |
-| tools | 系统工具目录 |
+| **目录** | **说明** |
+|-------------------------|------------------------------------------------------|
+| conf | 配置文件目录，包含 ConfigNode 和 DataNode 的配置文件 |
+| data | 数据文件目录，包含 ConfigNode 和 DataNode 的数据文件 |
+| grafana-metrics-example | Grafana 监控界面模板 |
+| lib | 库文件目录 |
+| licenses | 证书文件目录 |
+| logs | 日志文件目录，包含 ConfigNode 和 DataNode 的日志文件 |
+| sbin | 脚本目录，包含 ConfigNode 和 DataNode 的启停移除脚本目录，以及 Cli 的启动脚本 |
+| tools | 系统工具目录 |
## 启动集群
@@ -82,38 +85,44 @@ mvn clean package -pl distribution -am -DskipTests
### 启动种子 ConfigNode
-对 confignode/conf/iotdb-confignode.properties 中的重要参数进行配置：
+对 confignode/conf/iotdb-confignode.properties 和 conf/iotdb-common.properties 中的重要参数进行配置：
+iotdb-confignode.properties：
-| **配置项** | **说明** |
-|--------------------------------------------|----------------------------------------------------|
-| internal\_address | ConfigNode 在集群内部通讯使用的地址 |
-| internal\_port | ConfigNode 在集群内部通讯使用的端口 |
-| consensus\_port | ConfigNode 副本组共识协议通信使用的端口 |
-| target\_config\_nodes | 种子 ConfigNode 地址，第一个 ConfigNode 配置自己的 address:port |
-| data\_replication\_factor | 数据副本数，DataNode 数量不应少于此数目 |
-| data\_region\_consensus\_protocol\_class | 数据副本组的共识协议 |
-| schema\_replication\_factor | 元数据副本数，DataNode 数量不应少于此数目 |
-| schema\_region\_consensus\_protocol\_class | 元数据副本组的共识协议 |
+| **配置项** | **说明** |
+|-------------------------------------------|----------------------------------------------------|
+| cn\_internal\_address | ConfigNode 在集群内部通讯使用的地址 |
+| cn\_internal\_port | ConfigNode 在集群内部通讯使用的端口 |
+| cn\_consensus\_port | ConfigNode 副本组共识协议通信使用的端口 |
+| cn\_target\_config\_node\_list | 种子 ConfigNode 地址，第一个 ConfigNode 配置自己的 address:port |
+
+iotdb-common.properties：
+
+| **配置项** | **说明** |
+|--------------------------------------------|---------------------------|
+| data\_replication\_factor | 数据副本数，DataNode 数量不应少于此数目 |
+| data\_region\_consensus\_protocol\_class | 数据副本组的共识协议 |
+| schema\_replication\_factor | 元数据副本数，DataNode 数量不应少于此数目 |
+| schema\_region\_consensus\_protocol\_class | 元数据副本组的共识协议 |
Linux 启动方式：
```
# 前台启动
-./confignode/sbin/start-confignode.sh
+./sbin/start-confignode.sh
# 后台启动
-nohup ./confignode/sbin/start-confignode.sh >/dev/null 2>&1 &
+nohup ./sbin/start-confignode.sh >/dev/null 2>&1 &
```
Windows 启动方式：
```
-confignode\sbin\start-confignode.bat
+sbin\start-confignode.bat
```
具体参考 [ConfigNode配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Reference/ConfigNode-Config-Manual.html)
### 增加 ConfigNode（可选）
-增加 ConfigNode 是一个扩容操作，除 IP 和端口不能冲突外，上述其它重要参数需要与集群已有的 ConfigNode 保持一致，并将 target\_config\_nodes 配置为集群活跃的 ConfigNode。
+增加 ConfigNode 是一个扩容操作，除 IP 和端口不能冲突外，上述其它重要参数需要与集群已有的 ConfigNode 保持一致，并将 cn\_target\_config\_nodes\_list 配置为集群活跃的 ConfigNode。
启动方式同上。
@@ -123,82 +132,94 @@ confignode\sbin\start-confignode.bat
iotdb-datanode.properties 中的重要配置如下：
-| **配置项** | **说明** |
-|---------------------------------|---------------------------|
-| rpc\_address | 客户端 RPC 服务的地址 |
-| rpc\_port | 客户端 RPC 服务的端口 |
-| internal\_address | DataNode 在集群内部接收控制流使用的端口 |
-| internal\_port | DataNode 在集群内部接收控制流使用的端口 |
-| mpp\_data\_exchange\_port | DataNode 在集群内部接收数据流使用的端口 |
-| data\_region\_consensus\_port | DataNode 的数据副本间共识协议通信的端口 |
-| schema\_region\_consensus\_port | DataNode 的元数据副本间共识协议通信的端口 |
-| target\_config\_nodes | 集群中正在运行的 ConfigNode 地址 |
+| **配置项** | **说明** |
+|-------------------------------------|---------------------------|
+| dn\_rpc\_address | 客户端 RPC 服务的地址 |
+| dn\_rpc\_port | 客户端 RPC 服务的端口 |
+| dn\_internal\_address | DataNode 在集群内部接收控制流使用的地址 |
+| dn\_internal\_port | DataNode 在集群内部接收控制流使用的端口 |
+| dn\_mpp\_data\_exchange\_port | DataNode 在集群内部接收数据流使用的端口 |
+| dn\_data\_region\_consensus\_port | DataNode 的数据副本间共识协议通信的端口 |
+| dn\_schema\_region\_consensus\_port | DataNode 的元数据副本间共识协议通信的端口 |
+| dn\_target\_config\_node\_list | 集群中正在运行的 ConfigNode 地址 |
Linux 启动方式：
```
# 前台启动
-./datanode/sbin/start-datanode.sh
+./sbin/start-datanode.sh
# 后台启动
-nohup ./datanode/sbin/start-datanode.sh >/dev/null 2>&1 &
+nohup ./sbin/start-datanode.sh >/dev/null 2>&1 &
```
Windows 启动方式：
```
-datanode\sbin\start-datanode.bat
+sbin\start-datanode.bat
```
具体参考 [DataNode配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Reference/DataNode-Config-Manual.html)。
### 启动 Cli
-Cli 启动脚本在 datanode/sbin 目录。
+Cli 启动脚本在 sbin 目录。
Linux 启动方式：
```
-./datanode/sbin/start-cli.sh
+./sbin/start-cli.sh
```
Windows 启动方式：
```
-datanode\sbin\start-cli.bat
+sbin\start-cli.bat
```
## 集群缩容
### 移除 ConfigNode
-需要在活跃的 ConfigNode 上执行 remove-confignode 脚本。
+需要在活跃的 ConfigNode 上执行 remove-confignode 脚本，且保证移除后集群中至少有一个活跃的 ConfigNode。
Linux 移除方式：
```
-./confignode/sbin/remove-confignode.sh <confignode_id>
-./confignode/sbin/remove-confignode.sh <internal_address>:<internal_port>
+# 根据 confignode_id 移除节点
+./sbin/remove-confignode.sh <confignode_id>
+
+# 根据 ConfigNode 内部通讯地址和端口移除节点
+./sbin/remove-confignode.sh <internal_address>:<internal_port>
```
Windows 移除方式：
```
-confignode\sbin\remove-confignode.bat <confignode_id>
-confignode\sbin\remove-confignode.bat <internal_address>:<internal_port>
+# 根据 confignode_id 移除节点
+sbin\remove-confignode.bat <confignode_id>
+
+# 根据 ConfigNode 内部通讯地址和端口移除节点
+sbin\remove-confignode.bat <internal_address>:<internal_port>
```
### 移除 DataNode
-需要在活跃的 DataNode 上执行 remove-datanode 脚本。
+需要在活跃的 DataNode 上执行 remove-datanode 脚本，且保证移除后集群中至少有不少于（数据/元数据）副本个数 的 DataNode。
Linux 移除方式：
```
-./datanode/sbin/remove-datanode.sh <datanode_id>
-./datanode/sbin/remove-datanode.sh <rpc_address>:<rpc_port>
+# 根据 datanode_id 移除节点
+./sbin/remove-datanode.sh <datanode_id>
+
+# 根据 DataNode RPC 服务地址和端口移除节点
+./sbin/remove-datanode.sh <rpc_address>:<rpc_port>
```
Windows 移除方式：
```
-datanode\sbin\remove-datanode.bat <datanode_id>
-datanode\sbin\remove-datanode.bat <rpc_address>:<rpc_port>
+# 根据 datanode_id 移除节点
+sbin\remove-datanode.bat <datanode_id>
+
+# 根据 DataNode RPC 服务地址和端口移除节点
+sbin\remove-datanode.bat <rpc_address>:<rpc_port>
```
## 快速上手
@@ -207,21 +228,21 @@ datanode\sbin\remove-datanode.bat <rpc_address>:<rpc_port>
### 1. 准备启动环境
-解压 apache-iotdb-0.14.0-preview1-all-bin.zip 至 cluster0 目录。
+解压 apache-iotdb-1.0.0-all-bin.zip 至 cluster0 目录。
### 2. 启动最小集群
-部署 1 个 ConfigNode 和 1 个 DataNode（1C1D）集群版，默认 1 副本：
+在 Linux 环境中，部署 1 个 ConfigNode 和 1 个 DataNode（1C1D）集群版，默认 1 副本：
```
-./cluster0/confignode/sbin/start-confignode.sh
-./cluster0/datanode/sbin/start-datanode.sh
+./cluster0/sbin/start-confignode.sh
+./cluster0/sbin/start-datanode.sh
```
### 3. 验证最小集群
+ 最小集群启动成功，启动 Cli 进行验证：
```
-./cluster0/datanode/sbin/start-cli.sh
+./cluster0/sbin/start-cli.sh
```
+ 在 Cli 执行 [show cluster](https://iotdb.apache.org/zh/UserGuide/Master/Maintenance-Tools/Maintenance-Command.html#%E6%9F%A5%E7%9C%8B%E5%85%A8%E9%83%A8%E8%8A%82%E7%82%B9%E4%BF%A1%E6%81%AF)
@@ -231,7 +252,7 @@ IoTDB> show cluster
+------+----------+-------+---------------+------------+
|NodeID| NodeType| Status|InternalAddress|InternalPort|
+------+----------+-------+---------------+------------+
-| 0|ConfigNode|Running| 0.0.0.0| 22277|
+| 0|ConfigNode|Running| 127.0.0.1| 22277|
| 1| DataNode|Running| 127.0.0.1| 9003|
+------+----------+-------+---------------+------------+
Total line number = 2
@@ -240,67 +261,67 @@ It costs 0.160s
### 4. 准备扩容环境
-解压 apache-iotdb-0.14.0-preview1-all-bin.zip 至 cluster1 目录和 cluster2 目录
+解压 apache-iotdb-1.0.0-all-bin.zip 至 cluster1 目录和 cluster2 目录
### 5. 修改节点配置文件
对于 cluster1 目录：
-+ 修改 ConfigNode 地址：
++ 修改 ConfigNode 配置：
-| **配置项** | **值** |
-|-----------------------|---------------|
-| internal\_address | 0.0.0.0 |
-| internal\_port | 22279 |
-| consensus\_port | 22280 |
-| target\_config\_nodes | 0.0.0.0:22277 |
+| **配置项** | **值** |
+|--------------------------------|-----------------|
+| cn\_internal\_address | 127.0.0.1 |
+| cn\_internal\_port | 22279 |
+| cn\_consensus\_port | 22280 |
+| cn\_target\_config\_node\_list | 127.0.0.1:22277 |
-+ 修改 DataNode 地址：
++ 修改 DataNode 配置：
-| **配置项** | **值** |
-|---------------------------------|-----------------|
-| rpc\_address | 0.0.0.0 |
-| rpc\_port | 6668 |
-| internal\_address | 127.0.0.1 |
-| internal\_port | 9004 |
-| mpp\_data\_exchange\_port | 8778 |
-| data\_region\_consensus\_port | 40011 |
-| schema\_region\_consensus\_port | 50011 |
-| target\_config\_nodes | 127.0.0.1:22277 |
+| **配置项** | **值** |
+|-------------------------------------|-----------------|
+| dn\_rpc\_address | 127.0.0.1 |
+| dn\_rpc\_port | 6668 |
+| dn\_internal\_address | 127.0.0.1 |
+| dn\_internal\_port | 9004 |
+| dn\_mpp\_data\_exchange\_port | 8778 |
+| dn\_data\_region\_consensus\_port | 40011 |
+| dn\_schema\_region\_consensus\_port | 50011 |
+| dn\_target\_config\_node\_list | 127.0.0.1:22277 |
对于 cluster2 目录：
-+ 修改 ConfigNode 地址：
++ 修改 ConfigNode 配置：
-| **配置项** | **值** |
-|-----------------------|---------------|
-| internal\_address | 0.0.0.0 |
-| internal\_port | 22281 |
-| consensus\_port | 22282 |
-| target\_config\_nodes | 0.0.0.0:22277 |
+| **配置项** | **值** |
+|--------------------------------|-----------------|
+| cn\_internal\_address | 127.0.0.1 |
+| cn\_internal\_port | 22281 |
+| cn\_consensus\_port | 22282 |
+| cn\_target\_config\_node\_list | 127.0.0.1:22277 |
-+ 修改 DataNode 地址：
++ 修改 DataNode 配置：
-| **配置项** | **值** |
-|---------------------------------|-----------------|
-| rpc\_address | 0.0.0.0 |
-| rpc\_port | 6669 |
-| internal\_address | 127.0.0.1 |
-| internal\_port | 9005 |
-| mpp\_data\_exchange\_port | 8779 |
-| data\_region\_consensus\_port | 40012 |
-| schema\_region\_consensus\_port | 50012 |
-| target\_config\_nodes | 127.0.0.1:22277 |
+| **配置项** | **值** |
+|-------------------------------------|-----------------|
+| dn\_rpc\_address | 127.0.0.1 |
+| dn\_rpc\_port | 6669 |
+| dn\_internal\_address | 127.0.0.1 |
+| dn\_internal\_port | 9005 |
+| dn\_mpp\_data\_exchange\_port | 8779 |
+| dn\_data\_region\_consensus\_port | 40012 |
+| dn\_schema\_region\_consensus\_port | 50012 |
+| dn\_target\_config\_node\_list | 127.0.0.1:22277 |
### 6. 集群扩容
将集群扩容至 3 个 ConfigNode 和 3 个 DataNode（3C3D）集群版，
-指令执行顺序可不分先后：
+指令执行顺序为先启动 ConfigNode，再启动 DataNode：
```
-./cluster1/confignode/sbin/start-confignode.sh
-./cluster1/datanode/sbin/start-datanode.sh
-./cluster2/confignode/sbin/start-confignode.sh
-./cluster2/datanode/sbin/start-datanode.sh
+./cluster1/sbin/start-confignode.sh
+./cluster2/sbin/start-confignode.sh
+./cluster1/sbin/start-datanode.sh
+./cluster2/sbin/start-datanode.sh
```
### 7. 验证扩容结果
@@ -311,9 +332,9 @@ IoTDB> show cluster
+------+----------+-------+---------------+------------+
|NodeID| NodeType| Status|InternalAddress|InternalPort|
+------+----------+-------+---------------+------------+
-| 0|ConfigNode|Running| 0.0.0.0| 22277|
-| 2|ConfigNode|Running| 0.0.0.0| 22279|
-| 3|ConfigNode|Running| 0.0.0.0| 22281|
+| 0|ConfigNode|Running| 127.0.0.1| 22277|
+| 2|ConfigNode|Running| 127.0.0.1| 22279|
+| 3|ConfigNode|Running| 127.0.0.1| 22281|
| 1| DataNode|Running| 127.0.0.1| 9003|
| 4| DataNode|Running| 127.0.0.1| 9004|
| 5| DataNode|Running| 127.0.0.1| 9005|
@@ -326,12 +347,12 @@ It costs 0.012s
+ 缩容一个 ConfigNode：
```
-./cluster0/confignode/sbin/remove-confignode.sh 127.0.0.1:22279
+./cluster0/sbin/remove-confignode.sh 127.0.0.1:22279
```
+ 缩容一个 DataNode：
```
-./cluster0/datanode/sbin/remove-datanode.sh 127.0.0.1:6668
+./cluster0/sbin/remove-datanode.sh 127.0.0.1:6668
```
### 9. 验证缩容结果
@@ -342,8 +363,8 @@ IoTDB> show cluster
+------+----------+-------+---------------+------------+
|NodeID| NodeType| Status|InternalAddress|InternalPort|
+------+----------+-------+---------------+------------+
-| 0|ConfigNode|Running| 0.0.0.0| 22277|
-| 3|ConfigNode|Running| 0.0.0.0| 22281|
+| 0|ConfigNode|Running| 127.0.0.1| 22277|
+| 3|ConfigNode|Running| 127.0.0.1| 22281|
| 1| DataNode|Running| 127.0.0.1| 9003|
| 5| DataNode|Running| 127.0.0.1| 9005|
+------+----------+-------+---------------+------------+
diff --git a/docs/zh/UserGuide/Maintenance-Tools/Maintenance-Command.md b/docs/zh/UserGuide/Maintenance-Tools/Maintenance-Command.md
index fba4cfc7b8..ff265cb6db 100644
--- a/docs/zh/UserGuide/Maintenance-Tools/Maintenance-Command.md
+++ b/docs/zh/UserGuide/Maintenance-Tools/Maintenance-Command.md
@@ -145,45 +145,26 @@ IoTDB> create timeseries root.sg.d2.s1 with datatype=BOOLEAN,encoding=PLAIN
Msg: The statement is executed successfully.
IoTDB> create timeseries root.ln.d1.s1 with datatype=BOOLEAN,encoding=PLAIN
Msg: The statement is executed successfully.
-IoTDB> show regions
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|RegionId| Type|Status|Database|Series Slots|Time Slots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-| 0|SchemaRegion| Up| root.sg| 2| 0| 1|127.0.0.1| 6667|Leader|
-| 1|SchemaRegion| Up| root.ln| 1| 0| 2|127.0.0.1| 6668|Leader|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-Total line number = 2
-It costs 0.013s
-
IoTDB> show datanodes
-+------+-------+---------+-------+-------------+---------------+
-|NodeID| Status| Host|RpcPort|DataRegionNum|SchemaRegionNum|
-+------+-------+---------+-------+-------------+---------------+
-| 1|Running|127.0.0.1| 6667| 0| 1|
-| 2|Running|127.0.0.1| 6668| 0| 1|
-+------+-------+---------+-------+-------------+---------------+
++------+-------+----------+-------+-------------+---------------+
+|NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum|
++------+-------+----------+-------+-------------+---------------+
+| 1|Running| 127.0.0.1| 6667| 0| 1|
+| 2|Running| 127.0.0.1| 6668| 0| 1|
++------+-------+----------+-------+-------------+---------------+
+
Total line number = 2
It costs 0.007s
IoTDB> insert into root.ln.d1(timestamp,s1) values(1,true)
Msg: The statement is executed successfully.
-IoTDB> show regions
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|RegionId| Type|Status|Database|Series Slots|Time Slots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-| 0|SchemaRegion| Up| root.sg| 2| 0| 1|127.0.0.1| 6667|Leader|
-| 1|SchemaRegion| Up| root.ln| 1| 0| 2|127.0.0.1| 6668|Leader|
-| 2| DataRegion| Up| root.ln| 1| 1| 1|127.0.0.1| 6667|Leader|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-Total line number = 3
-It costs 0.008s
IoTDB> show datanodes
-+------+-------+---------+-------+-------------+---------------+
-|NodeID| Status| Host|RpcPort|DataRegionNum|SchemaRegionNum|
-+------+-------+---------+-------+-------------+---------------+
-| 1|Running|127.0.0.1| 6667| 1| 1|
-| 2|Running|127.0.0.1| 6668| 0| 1|
-+------+-------+---------+-------+-------------+---------------+
++------+-------+----------+-------+-------------+---------------+
+|NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum|
++------+-------+----------+-------+-------------+---------------+
+| 1|Running| 127.0.0.1| 6667| 1| 1|
+| 2|Running| 127.0.0.1| 6668| 0| 1|
++------+-------+----------+-------+-------------+---------------+
Total line number = 2
It costs 0.006s
```
@@ -208,13 +189,13 @@ SHOW CONFIGNODES
```
IoTDB> show confignodes
-+------+-------+-------+------------+--------+
-|NodeID| Status| Host|InternalPort| Role|
-+------+-------+-------+------------+--------+
-| 0|Running|0.0.0.0| 22277| Leader|
-| 1|Running|0.0.0.0| 22279|Follower|
-| 2|Running|0.0.0.0| 22281|Follower|
-+------+-------+-------+------------+--------+
++------+-------+---------------+------------+--------+
+|NodeID| Status|InternalAddress|InternalPort| Role|
++------+-------+---------------+------------+--------+
+| 0|Running| 127.0.0.1| 22277| Leader|
+| 1|Running| 127.0.0.1| 22279|Follower|
+| 2|Running| 127.0.0.1| 22281|Follower|
++------+-------+---------------+------------+--------+
Total line number = 3
It costs 0.030s
```
@@ -240,9 +221,9 @@ IoTDB> show cluster
+------+----------+-------+---------------+------------+
|NodeID| NodeType| Status|InternalAddress|InternalPort|
+------+----------+-------+---------------+------------+
-| 0|ConfigNode|Running| 0.0.0.0| 22277|
-| 1|ConfigNode|Running| 0.0.0.0| 22279|
-| 2|ConfigNode|Running| 0.0.0.0| 22281|
+| 0|ConfigNode|Running| 127.0.0.1| 22277|
+| 1|ConfigNode|Running| 127.0.0.1| 22279|
+| 2|ConfigNode|Running| 127.0.0.1| 22281|
| 3| DataNode|Running| 127.0.0.1| 9003|
| 4| DataNode|Running| 127.0.0.1| 9005|
| 5| DataNode|Running| 127.0.0.1| 9007|
@@ -289,22 +270,22 @@ It costs 0.340s
展示所有 Region 的分布：
```
IoTDB> show regions
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0| DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0| DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0| DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 1|0.0.0.0| 6667| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 2|0.0.0.0| 6668|Follower|
-| 2| DataRegion|Running| root.sg2| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 2|0.0.0.0| 6668| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|
+| 2| DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 12
It costs 0.165s
```
@@ -312,30 +293,30 @@ It costs 0.165s
展示 SchemaRegion 或 DataRegion 的分布：
```
IoTDB> show data regions
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0| DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0| DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0| DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 2| DataRegion|Running| root.sg2| 1| 1| 1|0.0.0.0| 6667| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 2|0.0.0.0| 6668|Follower|
-| 2| DataRegion|Running| root.sg2| 1| 1| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|
+| 2| DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.011s
IoTDB> show schema regions
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 2|0.0.0.0| 6668| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.012s
```
@@ -343,64 +324,64 @@ It costs 0.012s
展示指定数据库 <sg1,sg2,...> 对应的 Region 分布：
```
IoTDB> show regions of database root.sg1
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0| DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0| DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0| DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+-- -----+-----------+---------+----------+----------+-------+--------+
+| 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.007s
IoTDB> show regions of database root.sg1, root.sg2
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0| DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0| DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0| DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 1|0.0.0.0| 6667| Leader|
-| 2| DataRegion|Running| root.sg2| 1| 1| 2|0.0.0.0| 6668|Follower|
-| 2| DataRegion|Running| root.sg2| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 2|0.0.0.0| 6668| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 0| DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0| DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0| DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|
+| 2| DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|
+| 2| DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 12
It costs 0.009s
IoTDB> show data regions of database root.sg1, root.sg2
-+--------+----------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+----------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 0|DataRegion|Running| root.sg1| 1| 1| 1|0.0.0.0| 6667|Follower|
-| 0|DataRegion|Running| root.sg1| 1| 1| 2|0.0.0.0| 6668| Leader|
-| 0|DataRegion|Running| root.sg1| 1| 1| 3|0.0.0.0| 6669|Follower|
-| 2|DataRegion|Running| root.sg2| 1| 1| 1|0.0.0.0| 6667| Leader|
-| 2|DataRegion|Running| root.sg2| 1| 1| 2|0.0.0.0| 6668|Follower|
-| 2|DataRegion|Running| root.sg2| 1| 1| 3|0.0.0.0| 6669|Follower|
-+--------+----------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+----------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+----------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 0|DataRegion|Running|root.sg1| 1| 1| 1| 127.0.0.1| 6667|Follower|
+| 0|DataRegion|Running|root.sg1| 1| 1| 2| 127.0.0.1| 6668| Leader|
+| 0|DataRegion|Running|root.sg1| 1| 1| 3| 127.0.0.1| 6669|Follower|
+| 2|DataRegion|Running|root.sg2| 1| 1| 1| 127.0.0.1| 6667| Leader|
+| 2|DataRegion|Running|root.sg2| 1| 1| 2| 127.0.0.1| 6668|Follower|
+| 2|DataRegion|Running|root.sg2| 1| 1| 3| 127.0.0.1| 6669|Follower|
++--------+----------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.007s
IoTDB> show schema regions of database root.sg1, root.sg2
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId| Host|RpcPort| Role|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 2|0.0.0.0| 6668|Follower|
-| 1|SchemaRegion|Running| root.sg1| 1| 0| 3|0.0.0.0| 6669| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 1|0.0.0.0| 6667|Follower|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 2|0.0.0.0| 6668| Leader|
-| 3|SchemaRegion|Running| root.sg2| 1| 0| 3|0.0.0.0| 6669|Follower|
-+--------+------------+-------+-------------+-----------+---------+----------+-------+-------+--------+
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+|RegionId| Type| Status|Database|SeriesSlots|TimeSlots|DataNodeId|RpcAddress|RpcPort| Role|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 2| 127.0.0.1| 6668|Follower|
+| 1|SchemaRegion|Running|root.sg1| 1| 0| 3| 127.0.0.1| 6669| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 1| 127.0.0.1| 6667|Follower|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 2| 127.0.0.1| 6668| Leader|
+| 3|SchemaRegion|Running|root.sg2| 1| 0| 3| 127.0.0.1| 6669|Follower|
++--------+------------+-------+--------+-----------+---------+----------+----------+-------+--------+
Total line number = 6
It costs 0.009s
```
diff --git a/server/src/main/java/org/apache/iotdb/db/mpp/common/header/ColumnHeaderConstant.java b/server/src/main/java/org/apache/iotdb/db/mpp/common/header/ColumnHeaderConstant.java
index fbe824027c..3c788b8eaf 100644
--- a/server/src/main/java/org/apache/iotdb/db/mpp/common/header/ColumnHeaderConstant.java
+++ b/server/src/main/java/org/apache/iotdb/db/mpp/common/header/ColumnHeaderConstant.java
@@ -221,7 +221,7 @@ public class ColumnHeaderConstant {
new ColumnHeader(SERIES_SLOT_ID, TSDataType.INT32),
new ColumnHeader(TIME_SLOT_ID, TSDataType.INT64),
new ColumnHeader(DATA_NODE_ID, TSDataType.INT32),
- new ColumnHeader(HOST, TSDataType.TEXT),
+ new ColumnHeader(RPC_ADDRESS, TSDataType.TEXT),
new ColumnHeader(RPC_PORT, TSDataType.INT32),
new ColumnHeader(ROLE, TSDataType.TEXT));
@@ -229,7 +229,7 @@ public class ColumnHeaderConstant {
ImmutableList.of(
new ColumnHeader(NODE_ID, TSDataType.INT32),
new ColumnHeader(STATUS, TSDataType.TEXT),
- new ColumnHeader(HOST, TSDataType.TEXT),
+ new ColumnHeader(RPC_ADDRESS, TSDataType.TEXT),
new ColumnHeader(RPC_PORT, TSDataType.INT32),
new ColumnHeader(DATA_REGION_NUM, TSDataType.INT32),
new ColumnHeader(SCHEMA_REGION_NUM, TSDataType.INT32));
@@ -238,7 +238,7 @@ public class ColumnHeaderConstant {
ImmutableList.of(
new ColumnHeader(NODE_ID, TSDataType.INT32),
new ColumnHeader(STATUS, TSDataType.TEXT),
- new ColumnHeader(HOST, TSDataType.TEXT),
+ new ColumnHeader(INTERNAL_ADDRESS, TSDataType.TEXT),
new ColumnHeader(INTERNAL_PORT, TSDataType.INT32),
new ColumnHeader(ROLE, TSDataType.TEXT));