Skip to content

Commit e677ec5

Browse files
authored
fix set configuration: add quote mark (#802)
1 parent 91247ba commit e677ec5

File tree

16 files changed

+48
-48
lines changed

16 files changed

+48
-48
lines changed

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/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

src/UserGuide/dev-1.3/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/dev-1.3/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

src/UserGuide/latest/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/latest/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/zh/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,21 @@ load configuration
3838
# 配置项操作语句
3939
设置配置项
4040
```
41-
set configuration key1 = 'value1' key2 = 'value2'... (on nodeId)
41+
set configuration 'key1' = 'value1' 'key2' = 'value2'... (on nodeId)
4242
```
4343
### 示例1
4444
```
45-
set configuration enable_cross_space_compaction = 'false'
45+
set configuration 'enable_cross_space_compaction' = 'false'
4646
```
4747
对集群所有节点永久生效,设置 enable_cross_space_compaction 为 false,并写入到 iotdb-system.properties 中。
4848
### 示例2
4949
```
50-
set configuration enable_cross_space_compaction ='false' enable_seq_space_compaction = 'false' on 1
50+
set configuration 'enable_cross_space_compaction' ='false' 'enable_seq_space_compaction' = 'false' on 1
5151
```
5252
对 nodeId 为 1 的节点永久生效,设置 enable_cross_space_compaction 为 false,设置 enable_seq_space_compaction 为 false,并写入到 iotdb-system.properties 中。
5353
### 示例3
5454
```
55-
set configuration enable_cross_space_compaction = 'false' timestamp_precision = 'ns'
55+
set configuration 'enable_cross_space_compaction' = 'false' 'timestamp_precision' = 'ns'
5656
```
5757
对集群所有节点永久生效,设置 enable_cross_space_compaction 为 false,timestamp_precision 为 ns,并写入到 iotdb-system.properties 中。但是,timestamp_precision 是第一次启动后就无法修改的配置项,因此会忽略这个配置项的更新,返回如下。
5858
```
@@ -63,7 +63,7 @@ Msg: org.apache.iotdb.jdbc.IoTDBSQLException: 301: ignored config items: [timest
6363
示例
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/zh/UserGuide/Master/Tree/User-Manual/Maintenance-statement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ propertyValue
281281
#### 示例:
282282

283283
```SQL
284-
IoTDB> SET CONFIGURATION a='1',b='1' ON 1;
284+
IoTDB> SET CONFIGURATION 'a'='1','b'='1' ON 1;
285285
```
286286

287287
### 2.3 读取手动修改的配置文件

0 commit comments

Comments
 (0)