Skip to content

Commit 0bed403

Browse files
leto-bleto-b
committed
fix-set-configuration-syntax-in-config-manual
1 parent 59fafdc commit 0bed403

File tree

12 files changed

+24
-24
lines changed

12 files changed

+24
-24
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/Master/Tree/Reference/Common-Config-Manual.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Different configuration parameters take effect in the following three ways:
3131

3232
+ **Only allowed to be modified in first start up:** Can't be modified after first start, otherwise the ConfigNode/DataNode cannot start.
3333
+ **After restarting system:** Can be modified after the ConfigNode/DataNode first start, but take effect after restart.
34-
+ **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.
34+
+ **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.
3535

3636
## 2. Configuration File
3737

@@ -201,7 +201,7 @@ Different configuration parameters take effect in the following three ways:
201201
| Description | The name of cluster |
202202
| Type | String |
203203
| Default | default_cluster |
204-
| Effective | Execute SQL in CLI: ```set configuration cluster_name='xxx'``` (xxx is the new cluster name) |
204+
| Effective | Execute SQL in CLI: ```set configuration 'cluster_name'='xxx'``` (xxx is the new cluster name) |
205205
| 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 manually modifying the configuration file, nor is it recommended to hot load through the load configuration method. |
206206

207207
* time\_partition\_interval

‎src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Different configuration parameters take effect in the following three ways:
3131

3232
+ **Only allowed to be modified in first start up:** Can't be modified after first start, otherwise the ConfigNode/DataNode cannot start.
3333
+ **After restarting system:** Can be modified after the ConfigNode/DataNode first start, but take effect after restart.
34-
+ **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.
34+
+ **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.
3535

3636
## Configuration File
3737

@@ -201,7 +201,7 @@ Different configuration parameters take effect in the following three ways:
201201
| Description | The name of cluster |
202202
| Type | String |
203203
| Default | default_cluster |
204-
| Effective | Execute SQL in CLI: ```set configuration cluster_name='xxx'``` (xxx is the new cluster name) |
204+
| Effective | Execute SQL in CLI: ```set configuration 'cluster_name'='xxx'``` (xxx is the new cluster name) |
205205
| 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 manually modifying the configuration file, nor is it recommended to hot load through the load configuration method. |
206206

207207
* time\_partition\_interval

‎src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Different configuration parameters take effect in the following three ways:
3131

3232
+ **Only allowed to be modified in first start up:** Can't be modified after first start, otherwise the ConfigNode/DataNode cannot start.
3333
+ **After restarting system:** Can be modified after the ConfigNode/DataNode first start, but take effect after restart.
34-
+ **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.
34+
+ **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.
3535

3636
## Configuration File
3737

@@ -201,7 +201,7 @@ Different configuration parameters take effect in the following three ways:
201201
| Description | The name of cluster |
202202
| Type | String |
203203
| Default | default_cluster |
204-
| Effective | Execute SQL in CLI: ```set configuration cluster_name='xxx'``` (xxx is the new cluster name) |
204+
| Effective | Execute SQL in CLI: ```set configuration 'cluster_name'='xxx'``` (xxx is the new cluster name) |
205205
| 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 manually modifying the configuration file, nor is it recommended to hot load through the load configuration method. |
206206

207207
* time\_partition\_interval

‎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

0 commit comments

Comments
 (0)