[iotdb] branch rel/1.1 updated: [IOTDB-4497][Doc] Improve NodeStatus definition

[yo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

yongzao pushed a commit to branch rel/1.1
in repository https://gitbox.apache.org/repos/asf/iotdb.git


The following commit(s) were added to refs/heads/rel/1.1 by this push:
     new 62e2021709 [IOTDB-4497][Doc] Improve NodeStatus definition
62e2021709 is described below

commit 62e2021709aae88fd9d19d84a6d6ca8e7c32ed13
Author: YongzaoDan <33...@users.noreply.github.com>
AuthorDate: Fri Mar 10 14:14:35 2023 +0800

    [IOTDB-4497][Doc] Improve NodeStatus definition
    
    [IOTDB-4497][Doc] Improve NodeStatus definition
---
 docs/UserGuide/Cluster/Cluster-Maintenance.md    | 15 +++++++++++++--
 docs/zh/UserGuide/Cluster/Cluster-Maintenance.md | 21 ++++++++++++++++-----
 2 files changed, 29 insertions(+), 7 deletions(-)

diff --git a/docs/UserGuide/Cluster/Cluster-Maintenance.md b/docs/UserGuide/Cluster/Cluster-Maintenance.md
index 0d61b46914..5f3289a8a5 100644
--- a/docs/UserGuide/Cluster/Cluster-Maintenance.md
+++ b/docs/UserGuide/Cluster/Cluster-Maintenance.md
@@ -136,8 +136,19 @@ The DataNode statuses are defined as follows:
   - The cluster is still readable and writable if some DataNodes are Removing
 - **ReadOnly**: The remaining disk space of DataNode is lower than disk_warning_threshold(default is 5%), the DataNode is readable but un-writable and cannot synchronize data.
   - The cluster is still readable and writable if some DataNodes are ReadOnly
-  - Schema, data and Database can be deleted in ReadOnly status
-  - Schema and data cannot be written to the cluster when all DataNodes are ReadOnly, but new Databases can still be created
+  - The schema and data in a ReadOnly DataNode is readable
+  - The schema and data in a ReadOnly DataNode is deletable
+  - A ReadOnly DataNode is creatable for schema, but un-writable for data
+  - Data cannot be written to the cluster when all DataNodes are ReadOnly, but new Databases and schema is still creatable
+
+**For a DataNode**, the following table describes the impact of schema read, write, and deletion in different status:
+
+| DataNode status | readable | creatable | deletable |
+|-----------------|----------|-----------|-----------|
+| Running         | yes      | yes       | yes       |
+| Unknown         | no       | no        | no        |
+| Removing        | no       | no        | no        |
+| ReadOnly        | yes      | yes       | yes       |
 
 **For a DataNode**, the following table describes the impact of data read, write, and deletion in different status:
 
diff --git a/docs/zh/UserGuide/Cluster/Cluster-Maintenance.md b/docs/zh/UserGuide/Cluster/Cluster-Maintenance.md
index 13d886631a..6cbc46329a 100644
--- a/docs/zh/UserGuide/Cluster/Cluster-Maintenance.md
+++ b/docs/zh/UserGuide/Cluster/Cluster-Maintenance.md
@@ -132,13 +132,24 @@ DataNode 的状态机如下图所示：
 
 - **Running**: DataNode 正常运行，可读可写
 - **Unknown**: DataNode 未正常上报心跳，ConfigNode 认为该 DataNode 不可读写
-  - 少数 DataNode Unknown 不影响集群读写
+  - 少数 Unknown DataNode 不影响集群读写
 - **Removing**: DataNode 正在移出集群，不可读写
-  - 少数 DataNode Removing 不影响集群读写 
+  - 少数 Removing DataNode 不影响集群读写 
 - **ReadOnly**: DataNode 磁盘剩余空间低于 disk_warning_threshold（默认 5%），DataNode 可读但不能写入，不能同步数据
-  - 少数 DataNode ReadOnly 不影响集群读写
-  - ReadOnly 状态下可以删除元数据和数据，可以删除 Database
-  - 所有 DataNode 处于 ReadOnly 状态时，集群不可写入元数据和数据，仍可以创建 Database
+  - 少数 ReadOnly DataNode 不影响集群读写
+  - ReadOnly DataNode 可以查询元数据和数据
+  - ReadOnly DataNode 可以删除元数据和数据
+  - ReadOnly DataNode 可以创建元数据，不能写入数据
+  - 所有 DataNode 处于 ReadOnly 状态时，集群不能写入数据，仍可以创建 Database 和元数据
+
+**对于一个 DataNode**，不同状态元数据查询、创建、删除的影响如下表所示：
+
+| DataNode 状态 | 可读  | 可创建 | 可删除 |
+|-------------|-----|-----|-----|
+| Running     | 是   | 是   | 是   |
+| Unknown     | 否   | 否   | 否   |
+| Removing    | 否   | 否   | 否   |
+| ReadOnly    | 是   | 是   | 是   |
 
 **对于一个 DataNode**，不同状态数据查询、写入、删除的影响如下表所示：