Skip to content

Commit 57f9b2e

Browse files
leto-bleto-b
authored
fix set configuration syntax (apache#752)
1 parent 3240124 commit 57f9b2e

32 files changed

+128
-128
lines changed

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

Lines changed: 7 additions & 7 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`: Updates specific configuration parameters.
65+
- `set configuration key1 = 'value1'`: Updates specific configuration parameters.
6666

6767
## 3. Environment Parameters
6868

@@ -134,12 +134,12 @@ The `iotdb-system.properties` file contains various configurations for managing
134134

135135
- cluster_name
136136

137-
| Name | cluster_name |
138-
| ----------- | ------------------------------------------------------------ |
139-
| Description | Name of the cluster. |
140-
| Type | String |
141-
| Default | default_cluster |
142-
| Effective | Use CLI: `set configuration "cluster_name"="xxx"`. |
137+
| Name | cluster_name |
138+
| ----------- | --------------------------------------------------------- |
139+
| Description | Name of the cluster. |
140+
| Type | String |
141+
| Default | default_cluster |
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/Table/User-Manual/Maintenance-commands.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ propertyValue
373373
**Example**:
374374

375375
```SQL
376-
IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1;
376+
IoTDB> SET CONFIGURATION a='1',b='1' ON 1;
377377
```
378378

379379
### 2.3 Loading Manually Modified Configuration Files

‎src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md‎

Lines changed: 7 additions & 7 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` 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

@@ -196,12 +196,12 @@ Different configuration parameters take effect in the following three ways:
196196

197197
* cluster\_name
198198

199-
| Name | cluster\_name |
200-
|:-----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
201-
| Description | The name of cluster |
202-
| Type | String |
203-
| Default | default_cluster |
204-
| Effective | Execute SQL in CLI: ```set configuration "cluster_name"="xxx"``` (xxx is the new cluster name) |
199+
| Name | cluster\_name |
200+
|:-----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
201+
| Description | The name of cluster |
202+
| Type | String |
203+
| Default | default_cluster |
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/Master/Tree/Reference/Modify-Config-Manual.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,21 @@ load configuration
3737
```
3838
# SetConfiguration statement
3939
```
40-
set configuration "key1"="value1" "key2"="value2"... (on nodeId)
40+
set configuration key1 = 'value1' key2 = 'value2'... (on nodeId)
4141
```
4242
### Example 1
4343
```
44-
set configuration "enable_cross_space_compaction"="false"
44+
set configuration enable_cross_space_compaction='false'
4545
```
4646
To take effect permanently on all nodes in the cluster, set enable_cross_space_compaction to false and write it to iotdb-system.properties.
4747
### Example 2
4848
```
49-
set configuration "enable_cross_space_compaction"="false" "enable_seq_space_compaction"="false" on 1
49+
set configuration enable_cross_space_compaction='false' enable_seq_space_compaction='false' on 1
5050
```
5151
To take effect permanently on the node with nodeId 1, set enable_cross_space_compaction to false, set enable_seq_space_compaction to false, and write it to iotdb-system.properties.
5252
### Example 3
5353
```
54-
set configuration "enable_cross_space_compaction"="false" "timestamp_precision"="ns"
54+
set configuration enable_cross_space_compaction='false' timestamp_precision='ns'
5555
```
5656
To take effect permanently on all nodes in the cluster, set enable_cross_space_compaction to false, timestamp_precision to ns, and write it to iotdb-system.properties. However, timestamp_precision is a configuration item that cannot be modified after the first startup, so the update of this configuration item will be ignored and the return is as follows.
5757
```
@@ -63,7 +63,7 @@ Configuration items that support hot reloading and take effect immediately are m
6363
Example
6464
```
6565
# Used for indicate cluster name and distinguish different cluster.
66-
# If you need to modify the cluster name, it's recommended to use 'set configuration "cluster_name=xxx"' sql.
66+
# If you need to modify the cluster name, it's recommended to use [set configuration cluster_name='xxx'] sql.
6767
# Manually modifying configuration file is not recommended, which may cause node restart fail.
6868
# effectiveMode: hot_reload
6969
# Datatype: string

‎src/UserGuide/Master/Tree/User-Manual/Maintenance-commands.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ propertyValue
280280
**Example**:
281281

282282
```SQL
283-
IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1;
283+
IoTDB> SET CONFIGURATION a='1',b='1' ON 1;
284284
```
285285

286286
### 2.3 Loading Manually Modified Configuration Files

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

Lines changed: 7 additions & 7 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` 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

@@ -196,12 +196,12 @@ Different configuration parameters take effect in the following three ways:
196196

197197
* cluster\_name
198198

199-
| Name | cluster\_name |
200-
|:-----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
201-
| Description | The name of cluster |
202-
| Type | String |
203-
| Default | default_cluster |
204-
| Effective | Execute SQL in CLI: ```set configuration "cluster_name"="xxx"``` (xxx is the new cluster name) |
199+
| Name | cluster\_name |
200+
|:-----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
201+
| Description | The name of cluster |
202+
| Type | String |
203+
| Default | default_cluster |
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/Modify-Config-Manual.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,21 @@ load configuration
3737
```
3838
# SetConfiguration statement
3939
```
40-
set configuration "key1"="value1" "key2"="value2"... (on nodeId)
40+
set configuration key1 = 'value1' key2 = 'value2'... (on nodeId)
4141
```
4242
### Example 1
4343
```
44-
set configuration "enable_cross_space_compaction"="false"
44+
set configuration enable_cross_space_compaction='false'
4545
```
4646
To take effect permanently on all nodes in the cluster, set enable_cross_space_compaction to false and write it to iotdb-system.properties.
4747
### Example 2
4848
```
49-
set configuration "enable_cross_space_compaction"="false" "enable_seq_space_compaction"="false" on 1
49+
set configuration enable_cross_space_compaction='false' enable_seq_space_compaction='false' on 1
5050
```
5151
To take effect permanently on the node with nodeId 1, set enable_cross_space_compaction to false, set enable_seq_space_compaction to false, and write it to iotdb-system.properties.
5252
### Example 3
5353
```
54-
set configuration "enable_cross_space_compaction"="false" "timestamp_precision"="ns"
54+
set configuration enable_cross_space_compaction='false' timestamp_precision='ns'
5555
```
5656
To take effect permanently on all nodes in the cluster, set enable_cross_space_compaction to false, timestamp_precision to ns, and write it to iotdb-system.properties. However, timestamp_precision is a configuration item that cannot be modified after the first startup, so the update of this configuration item will be ignored and the return is as follows.
5757
```
@@ -63,7 +63,7 @@ Configuration items that support hot reloading and take effect immediately are m
6363
Example
6464
```
6565
# Used for indicate cluster name and distinguish different cluster.
66-
# If you need to modify the cluster name, it's recommended to use 'set configuration "cluster_name=xxx"' sql.
66+
# If you need to modify the cluster name, it's recommended to use [set configuration cluster_name='xxx'] sql.
6767
# Manually modifying configuration file is not recommended, which may cause node restart fail.
6868
# effectiveMode: hot_reload
6969
# Datatype: string

‎src/UserGuide/V1.3.x/User-Manual/Maintenance-commands.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ propertyValue
225225
**Example**:
226226

227227
```SQL
228-
IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1;
228+
IoTDB> SET CONFIGURATION a='1',b='1' ON 1;
229229
```
230230

231231
### 2.2 Loading Manually Modified Configuration Files

0 commit comments

Comments
 (0)