This is an automated email from the ASF dual-hosted git repository.
qiaojialin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new ca4fa133 Set cluster name (#273)
ca4fa133 is described below
commit ca4fa133ae5c58a31ce48e191b7571f854938fc1
Author: Li Yu Heng <[email protected]>
AuthorDate: Fri Nov 8 16:43:34 2024 +0800
Set cluster name (#273)
---
.../latest/Reference/Common-Config-Manual.md | 23 ++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md
b/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md
index 75f58c34..4a84bce8 100644
--- a/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md
+++ b/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md
@@ -27,12 +27,17 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
* `iotdb-common.properties`：IoTDB 集群的公共配置。
-### 改后生效方式
+### 修改与生效方式
+
不同的配置参数有不同的生效方式，分为以下三种：
-+ **仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致
ConfigNode/DataNode 无法启动。
-+ **重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。
-+ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load
configuration``` 或 `set configuration` 命令（SQL）至 IoTDB 使配置生效。
+**仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致
ConfigNode/DataNode 无法启动。
+**重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。
+
+**热加载：**
+ 手动修改配置文件 + ```load configuration```：可在 DataNode 运行时修改，修改后通过 Session 或 Cli 发送
```load configuration``` 命令至 IoTDB 使配置生效。
+ ```set configuration```：对于需要整个集群统一的参数，推荐使用此 SQL 修改。
+
### 系统配置项
@@ -196,6 +201,16 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
#### 集群管理
+* cluster\_name
+
+| 名字 | cluster\_name
|
+|:----:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 描述 | 集群名称
|
+| 类型 | String
|
+| 默认值 | default_cluster
|
+| 修改方式 | CLI 中执行语句 ```set configuration "cluster_name"="xxx"```
（xxx为希望修改成的集群名称）
|
+| 注意 |
此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过```load
configuration```的方式热加载。 |
+
* time\_partition\_interval
| 名字 | time\_partition\_interval |
