Skip to content

Commit ef67536

Browse files
committed
fix-set-configuration-syntax-in-config-manual
1 parent 0bed403 commit ef67536

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

src/UserGuide/Master/Table/Reference/System-Config-Manual.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Different configuration parameters have different update methods, categorized as
6262
1. These parameters can be modified while ConfigNode/DataNode is running.
6363
2. After modification, use the following SQL commands to apply the changes:
6464
- `load configuration`: Reloads the configuration.
65-
- `set configuration 'key1' = 'value1'`: Updates specific configuration parameters.
65+
- `set configuration key1 = 'value1'`: Updates specific configuration parameters.
6666

6767
## 3. Environment Parameters
6868

@@ -139,7 +139,7 @@ The `iotdb-system.properties` file contains various configurations for managing
139139
| Description | Name of the cluster. |
140140
| Type | String |
141141
| Default | default_cluster |
142-
| Effective | Use CLI: `set configuration 'cluster_name'='xxx'`. |
142+
| Effective | Use CLI: `set configuration cluster_name='xxx'`. |
143143
| Note | Changes are distributed across nodes. Changes may not propagate to all nodes in case of network issues or node failures. Nodes that fail to update must manually modify `cluster_name` in their configuration files and restart. Under normal circumstances, it is not recommended to modify `cluster_name` by manually modifying configuration files or to perform hot-loading via `load configuration` method. |
144144

145145
### 4.2 Seed ConfigNode

src/UserGuide/latest-Table/Reference/System-Config-Manual.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Different configuration parameters have different update methods, categorized as
6262
1. These parameters can be modified while ConfigNode/DataNode is running.
6363
2. After modification, use the following SQL commands to apply the changes:
6464
- `load configuration`: Reloads the configuration.
65-
- `set configuration 'key1' = 'value1'`: Updates specific configuration parameters.
65+
- `set configuration key1 = 'value1'`: Updates specific configuration parameters.
6666

6767
## 3. Environment Parameters
6868

@@ -139,7 +139,7 @@ The `iotdb-system.properties` file contains various configurations for managing
139139
| Description | Name of the cluster. |
140140
| Type | String |
141141
| Default | default_cluster |
142-
| Effective | Use CLI: `set configuration 'cluster_name'='xxx'`. |
142+
| Effective | Use CLI: `set configuration cluster_name='xxx'`. |
143143
| Note | Changes are distributed across nodes. Changes may not propagate to all nodes in case of network issues or node failures. Nodes that fail to update must manually modify `cluster_name` in their configuration files and restart. Under normal circumstances, it is not recommended to modify `cluster_name` by manually modifying configuration files or to perform hot-loading via `load configuration` method. |
144144

145145
### 4.2 Seed ConfigNode

src/zh/UserGuide/Master/Table/Reference/System-Config-Manual.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
3838

3939
- 仅允许在第一次启动服务前修改: 在第一次启动 ConfigNode/DataNode 后即禁止修改,修改会导致 ConfigNode/DataNode 无法启动。
4040
- 重启服务生效: ConfigNode/DataNode 启动后仍可修改,但需要重启 ConfigNode/DataNode 后才生效。
41-
- 热加载: 可在 ConfigNode/DataNode 运行时修改,修改后通过 Session 或 Cli 发送 `load configuration``set configuration 'key1' = 'value1'` 命令(SQL)至 IoTDB 使配置生效。
41+
- 热加载: 可在 ConfigNode/DataNode 运行时修改,修改后通过 Session 或 Cli 发送 `load configuration``set configuration key1 = 'value1'` 命令(SQL)至 IoTDB 使配置生效。
4242

4343
## 2. 环境配置项
4444

@@ -116,7 +116,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
116116
| 描述 | 集群名称 |
117117
| 类型 | String |
118118
| 默认值 | default_cluster |
119-
| 修改方式 | CLI 中执行语句 `set configuration 'cluster_name'='xxx'` (xxx为希望修改成的集群名称) |
119+
| 修改方式 | CLI 中执行语句 `set configuration cluster_name='xxx'` (xxx为希望修改成的集群名称) |
120120
| 注意 | 此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下,不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群,此时需要手动修改该节点的配置文件中的cluster_name项,再重启。正常情况下,不建议通过手动修改配置文件的方式修改集群名称,不建议通过`load configuration`的方式热加载。 |
121121

122122
### 3.2 SeedConfigNode 配置

src/zh/UserGuide/latest-Table/Reference/System-Config-Manual.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
3838

3939
- 仅允许在第一次启动服务前修改: 在第一次启动 ConfigNode/DataNode 后即禁止修改,修改会导致 ConfigNode/DataNode 无法启动。
4040
- 重启服务生效: ConfigNode/DataNode 启动后仍可修改,但需要重启 ConfigNode/DataNode 后才生效。
41-
- 热加载: 可在 ConfigNode/DataNode 运行时修改,修改后通过 Session 或 Cli 发送 `load configuration``set configuration 'key1' = 'value1'` 命令(SQL)至 IoTDB 使配置生效。
41+
- 热加载: 可在 ConfigNode/DataNode 运行时修改,修改后通过 Session 或 Cli 发送 `load configuration``set configuration key1 = 'value1'` 命令(SQL)至 IoTDB 使配置生效。
4242

4343
## 2. 环境配置项
4444

@@ -116,7 +116,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
116116
| 描述 | 集群名称 |
117117
| 类型 | String |
118118
| 默认值 | default_cluster |
119-
| 修改方式 | CLI 中执行语句 `set configuration 'cluster_name' = 'xxx'` (xxx为希望修改成的集群名称) |
119+
| 修改方式 | CLI 中执行语句 `set configuration cluster_name = 'xxx'` (xxx为希望修改成的集群名称) |
120120
| 注意 | 此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下,不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群,此时需要手动修改该节点的配置文件中的cluster_name项,再重启。正常情况下,不建议通过手动修改配置文件的方式修改集群名称,不建议通过`load configuration`的方式热加载。 |
121121

122122
### 3.2 SeedConfigNode 配置

0 commit comments

Comments
 (0)