This is an automated email from the ASF dual-hosted git repository.
critas 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 0210c188 fix-set-configuration-syntax-in-config-manual (#848)
0210c188 is described below
commit 0210c1884610bd20cdb44d3eef8468841e7e4e6d
Author: leto-b <[email protected]>
AuthorDate: Thu Aug 28 17:04:04 2025 +0800
fix-set-configuration-syntax-in-config-manual (#848)
* fix-set-configuration-syntax-in-config-manual
* fix-set-configuration-syntax-in-config-manual
---
src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md | 4 ++--
src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md | 4 ++--
src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md | 4 ++--
src/UserGuide/latest/Reference/Common-Config-Manual.md | 4 ++--
src/zh/UserGuide/Master/Tree/Reference/Common-Config-Manual.md | 4 ++--
src/zh/UserGuide/V1.3.x/Reference/Common-Config-Manual.md | 4 ++--
src/zh/UserGuide/dev-1.3/Reference/Common-Config-Manual.md | 4 ++--
src/zh/UserGuide/latest/Reference/Common-Config-Manual.md | 4 ++--
8 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md
b/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md
index dd3600c4..e8ca5ced 100644
--- a/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md
+++ b/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md
@@ -31,7 +31,7 @@ Different configuration parameters take effect in the
following three ways:
+ **Only allowed to be modified in first start up:** Can't be modified after
first start, otherwise the ConfigNode/DataNode cannot start.
+ **After restarting system:** Can be modified after the ConfigNode/DataNode
first start, but take effect after restart.
-+ **hot-load:** Can be modified while the ConfigNode/DataNode is running, and
trigger through sending the command(sql) `load configuration` or `set
configuration key1 = 'value1'` to the IoTDB server by client or session.
++ **hot-load:** Can be modified while the ConfigNode/DataNode is running, and
trigger through sending the command(sql) `load configuration` or `set
configuration 'key1' = 'value1'` to the IoTDB server by client or session.
## 2. Configuration File
@@ -201,7 +201,7 @@ Different configuration parameters take effect in the
following three ways:
| Description | The name of cluster
[...]
| Type | String
[...]
| Default | default_cluster
[...]
-| Effective | Execute SQL in CLI: ```set configuration cluster_name='xxx'```
(xxx is the new cluster name)
[...]
+| Effective | Execute SQL in CLI: ```set configuration
'cluster_name'='xxx'``` (xxx is the new cluster name)
[...]
| Attention | This change is distributed to each node through the network.
In the event of network fluctuations or node downtime, it is not guaranteed
that the modification will be successful on all nodes. Nodes that fail to
modify will not be able to join the cluster upon restart. At this time, it is
necessary to manually modify the cluster_name item in the configuration file of
the node, and then restart. Under normal circumstances, it is not recommended
to change the cluster name by [...]
* time\_partition\_interval
diff --git a/src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md
b/src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md
index 67f2942a..104b28b0 100644
--- a/src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md
+++ b/src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md
@@ -31,7 +31,7 @@ Different configuration parameters take effect in the
following three ways:
+ **Only allowed to be modified in first start up:** Can't be modified after
first start, otherwise the ConfigNode/DataNode cannot start.
+ **After restarting system:** Can be modified after the ConfigNode/DataNode
first start, but take effect after restart.
-+ **hot-load:** Can be modified while the ConfigNode/DataNode is running, and
trigger through sending the command(sql) `load configuration` or `set
configuration key1 = 'value1'` to the IoTDB server by client or session.
++ **hot-load:** Can be modified while the ConfigNode/DataNode is running, and
trigger through sending the command(sql) `load configuration` or `set
configuration 'key1' = 'value1'` to the IoTDB server by client or session.
## Configuration File
@@ -201,7 +201,7 @@ Different configuration parameters take effect in the
following three ways:
| Description | The name of cluster
[...]
| Type | String
[...]
| Default | default_cluster
[...]
-| Effective | Execute SQL in CLI: ```set configuration cluster_name='xxx'```
(xxx is the new cluster name)
[...]
+| Effective | Execute SQL in CLI: ```set configuration
'cluster_name'='xxx'``` (xxx is the new cluster name)
[...]
| Attention | This change is distributed to each node through the network.
In the event of network fluctuations or node downtime, it is not guaranteed
that the modification will be successful on all nodes. Nodes that fail to
modify will not be able to join the cluster upon restart. At this time, it is
necessary to manually modify the cluster_name item in the configuration file of
the node, and then restart. Under normal circumstances, it is not recommended
to change the cluster name by [...]
* time\_partition\_interval
diff --git a/src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md
b/src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md
index 17c96785..5c7125d6 100644
--- a/src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md
+++ b/src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md
@@ -31,7 +31,7 @@ Different configuration parameters take effect in the
following three ways:
+ **Only allowed to be modified in first start up:** Can't be modified after
first start, otherwise the ConfigNode/DataNode cannot start.
+ **After restarting system:** Can be modified after the ConfigNode/DataNode
first start, but take effect after restart.
-+ **hot-load:** Can be modified while the ConfigNode/DataNode is running, and
trigger through sending the command(sql) `load configuration` or `set
configuration key1 = 'value1'` to the IoTDB server by client or session.
++ **hot-load:** Can be modified while the ConfigNode/DataNode is running, and
trigger through sending the command(sql) `load configuration` or `set
configuration 'key1' = 'value1'` to the IoTDB server by client or session.
## Configuration File
@@ -201,7 +201,7 @@ Different configuration parameters take effect in the
following three ways:
| Description | The name of cluster
[...]
| Type | String
[...]
| Default | default_cluster
[...]
-| Effective | Execute SQL in CLI: ```set configuration cluster_name='xxx'```
(xxx is the new cluster name)
[...]
+| Effective | Execute SQL in CLI: ```set configuration
'cluster_name'='xxx'``` (xxx is the new cluster name)
[...]
| Attention | This change is distributed to each node through the network.
In the event of network fluctuations or node downtime, it is not guaranteed
that the modification will be successful on all nodes. Nodes that fail to
modify will not be able to join the cluster upon restart. At this time, it is
necessary to manually modify the cluster_name item in the configuration file of
the node, and then restart. Under normal circumstances, it is not recommended
to change the cluster name by [...]
* time\_partition\_interval
diff --git a/src/UserGuide/latest/Reference/Common-Config-Manual.md
b/src/UserGuide/latest/Reference/Common-Config-Manual.md
index 10095fd0..68e8eef0 100644
--- a/src/UserGuide/latest/Reference/Common-Config-Manual.md
+++ b/src/UserGuide/latest/Reference/Common-Config-Manual.md
@@ -31,7 +31,7 @@ Different configuration parameters take effect in the
following three ways:
+ **Only allowed to be modified in first start up:** Can't be modified after
first start, otherwise the ConfigNode/DataNode cannot start.
+ **After restarting system:** Can be modified after the ConfigNode/DataNode
first start, but take effect after restart.
-+ **hot-load:** Can be modified while the ConfigNode/DataNode is running, and
trigger through sending the command(sql) `load configuration` or `set
configuration key1 = 'value1'` to the IoTDB server by client or session.
++ **hot-load:** Can be modified while the ConfigNode/DataNode is running, and
trigger through sending the command(sql) `load configuration` or `set
configuration 'key1' = 'value1'` to the IoTDB server by client or session.
## 2. Configuration File
@@ -201,7 +201,7 @@ Different configuration parameters take effect in the
following three ways:
| Description | The name of cluster
[...]
| Type | String
[...]
| Default | default_cluster
[...]
-| Effective | Execute SQL in CLI: ```set configuration cluster_name='xxx'```
(xxx is the new cluster name)
[...]
+| Effective | Execute SQL in CLI: ```set configuration
'cluster_name'='xxx'``` (xxx is the new cluster name)
[...]
| Attention | This change is distributed to each node through the network.
In the event of network fluctuations or node downtime, it is not guaranteed
that the modification will be successful on all nodes. Nodes that fail to
modify will not be able to join the cluster upon restart. At this time, it is
necessary to manually modify the cluster_name item in the configuration file of
the node, and then restart. Under normal circumstances, it is not recommended
to change the cluster name by [...]
* time\_partition\_interval
diff --git a/src/zh/UserGuide/Master/Tree/Reference/Common-Config-Manual.md
b/src/zh/UserGuide/Master/Tree/Reference/Common-Config-Manual.md
index 058473fa..3ebffd6a 100644
--- a/src/zh/UserGuide/Master/Tree/Reference/Common-Config-Manual.md
+++ b/src/zh/UserGuide/Master/Tree/Reference/Common-Config-Manual.md
@@ -32,7 +32,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
+ **仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致
ConfigNode/DataNode 无法启动。
+ **重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。
-+ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load
configuration``` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。
++ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load
configuration``` 或 `set configuration 'key1' = 'value1'` 命令（SQL）至 IoTDB 使配置生效。
### 1.2 系统配置项
@@ -203,7 +203,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
| 描述 | 集群名称
|
| 类型 | String
|
| 默认值 | default_cluster
|
-| 修改方式 | CLI 中执行语句 ```set configuration cluster_name='xxx'``` （xxx为希望修改成的集群名称）
|
+| 修改方式 | CLI 中执行语句 ```set configuration 'cluster_name'='xxx'```
（xxx为希望修改成的集群名称）
|
| 注意 |
此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过```load
configuration```的方式热加载。 |
* time\_partition\_interval
diff --git a/src/zh/UserGuide/V1.3.x/Reference/Common-Config-Manual.md
b/src/zh/UserGuide/V1.3.x/Reference/Common-Config-Manual.md
index e4f4c312..cd9c610c 100644
--- a/src/zh/UserGuide/V1.3.x/Reference/Common-Config-Manual.md
+++ b/src/zh/UserGuide/V1.3.x/Reference/Common-Config-Manual.md
@@ -32,7 +32,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
+ **仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致
ConfigNode/DataNode 无法启动。
+ **重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。
-+ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load
configuration``` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。
++ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load
configuration``` 或 `set configuration 'key1' = 'value1'` 命令（SQL）至 IoTDB 使配置生效。
### 系统配置项
@@ -203,7 +203,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
| 描述 | 集群名称
|
| 类型 | String
|
| 默认值 | default_cluster
|
-| 修改方式 | CLI 中执行语句 ```set configuration cluster_name='xxx'``` （xxx为希望修改成的集群名称）
|
+| 修改方式 | CLI 中执行语句 ```set configuration 'cluster_name'='xxx'```
（xxx为希望修改成的集群名称）
|
| 注意 |
此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过```load
configuration```的方式热加载。 |
* time\_partition\_interval
diff --git a/src/zh/UserGuide/dev-1.3/Reference/Common-Config-Manual.md
b/src/zh/UserGuide/dev-1.3/Reference/Common-Config-Manual.md
index 81e5cead..91ec58d2 100644
--- a/src/zh/UserGuide/dev-1.3/Reference/Common-Config-Manual.md
+++ b/src/zh/UserGuide/dev-1.3/Reference/Common-Config-Manual.md
@@ -32,7 +32,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
+ **仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致
ConfigNode/DataNode 无法启动。
+ **重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。
-+ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load
configuration``` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。
++ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load
configuration``` 或 `set configuration 'key1' = 'value1'` 命令（SQL）至 IoTDB 使配置生效。
### 系统配置项
@@ -203,7 +203,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
| 描述 | 集群名称
|
| 类型 | String
|
| 默认值 | default_cluster
|
-| 修改方式 | CLI 中执行语句 ```set configuration cluster_name='xxx'``` （xxx为希望修改成的集群名称）
|
+| 修改方式 | CLI 中执行语句 ```set configuration 'cluster_name'='xxx'```
（xxx为希望修改成的集群名称）
|
| 注意 |
此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过```load
configuration```的方式热加载。 |
* time\_partition\_interval
diff --git a/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md
b/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md
index 058473fa..3ebffd6a 100644
--- a/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md
+++ b/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md
@@ -32,7 +32,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
+ **仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致
ConfigNode/DataNode 无法启动。
+ **重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。
-+ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load
configuration``` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。
++ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load
configuration``` 或 `set configuration 'key1' = 'value1'` 命令（SQL）至 IoTDB 使配置生效。
### 1.2 系统配置项
@@ -203,7 +203,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
| 描述 | 集群名称
|
| 类型 | String
|
| 默认值 | default_cluster
|
-| 修改方式 | CLI 中执行语句 ```set configuration cluster_name='xxx'``` （xxx为希望修改成的集群名称）
|
+| 修改方式 | CLI 中执行语句 ```set configuration 'cluster_name'='xxx'```
（xxx为希望修改成的集群名称）
|
| 注意 |
此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过```load
configuration```的方式热加载。 |
* time\_partition\_interval
