Skip to content

fix set configuration syntax #752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CritasWang merged 1 commit into from
May 21, 2025
Merged

fix set configuration syntax #752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/UserGuide/Master/Table/Reference/System-Config-Manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Different configuration parameters have different update methods, categorized as
1. These parameters can be modified while ConfigNode/DataNode is running.
2. After modification, use the following SQL commands to apply the changes:
- `load configuration`: Reloads the configuration.
- `set configuration`: Updates specific configuration parameters.
- `set configuration key1 = 'value1'`: Updates specific configuration parameters.

## 3. Environment Parameters

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

- cluster_name

| Name | cluster_name |
| ----------- | ------------------------------------------------------------ |
| Description | Name of the cluster. |
| Type | String |
| Default | default_cluster |
| Effective | Use CLI: `set configuration "cluster_name"="xxx"`. |
| Name | cluster_name |
| ----------- | --------------------------------------------------------- |
| Description | Name of the cluster. |
| Type | String |
| Default | default_cluster |
| Effective | Use CLI: `set configuration cluster_name='xxx'`. |
| 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. |

### 4.2 Seed ConfigNode
Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ propertyValue
**Example**:

```SQL
IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1;
IoTDB> SET CONFIGURATION a='1',b='1' ON 1;
```

### 2.3 Loading Manually Modified Configuration Files
Expand Down
14 changes: 7 additions & 7 deletions src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` 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

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

* cluster\_name

| Name | cluster\_name |
|:-----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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) |
| Name | cluster\_name |
|:-----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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) |
| 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. |

* time\_partition\_interval
Expand Down
10 changes: 5 additions & 5 deletions src/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,21 @@ load configuration
```
# SetConfiguration statement
```
set configuration "key1"="value1" "key2"="value2"... (on nodeId)
set configuration key1 = 'value1' key2 = 'value2'... (on nodeId)
```
### Example 1
```
set configuration "enable_cross_space_compaction"="false"
set configuration enable_cross_space_compaction='false'
```
To take effect permanently on all nodes in the cluster, set enable_cross_space_compaction to false and write it to iotdb-system.properties.
### Example 2
```
set configuration "enable_cross_space_compaction"="false" "enable_seq_space_compaction"="false" on 1
set configuration enable_cross_space_compaction='false' enable_seq_space_compaction='false' on 1
```
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.
### Example 3
```
set configuration "enable_cross_space_compaction"="false" "timestamp_precision"="ns"
set configuration enable_cross_space_compaction='false' timestamp_precision='ns'
```
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.
```
Expand All @@ -63,7 +63,7 @@ Configuration items that support hot reloading and take effect immediately are m
Example
```
# Used for indicate cluster name and distinguish different cluster.
# If you need to modify the cluster name, it's recommended to use 'set configuration "cluster_name=xxx"' sql.
# If you need to modify the cluster name, it's recommended to use [set configuration cluster_name='xxx'] sql.
# Manually modifying configuration file is not recommended, which may cause node restart fail.
# effectiveMode: hot_reload
# Datatype: string
Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/Master/Tree/User-Manual/Maintenance-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ propertyValue
**Example**:

```SQL
IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1;
IoTDB> SET CONFIGURATION a='1',b='1' ON 1;
```

### 2.3 Loading Manually Modified Configuration Files
Expand Down
14 changes: 7 additions & 7 deletions src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` 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

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

* cluster\_name

| Name | cluster\_name |
|:-----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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) |
| Name | cluster\_name |
|:-----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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) |
| 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. |

* time\_partition\_interval
Expand Down
10 changes: 5 additions & 5 deletions src/UserGuide/V1.3.x/Reference/Modify-Config-Manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,21 @@ load configuration
```
# SetConfiguration statement
```
set configuration "key1"="value1" "key2"="value2"... (on nodeId)
set configuration key1 = 'value1' key2 = 'value2'... (on nodeId)
```
### Example 1
```
set configuration "enable_cross_space_compaction"="false"
set configuration enable_cross_space_compaction='false'
```
To take effect permanently on all nodes in the cluster, set enable_cross_space_compaction to false and write it to iotdb-system.properties.
### Example 2
```
set configuration "enable_cross_space_compaction"="false" "enable_seq_space_compaction"="false" on 1
set configuration enable_cross_space_compaction='false' enable_seq_space_compaction='false' on 1
```
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.
### Example 3
```
set configuration "enable_cross_space_compaction"="false" "timestamp_precision"="ns"
set configuration enable_cross_space_compaction='false' timestamp_precision='ns'
```
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.
```
Expand All @@ -63,7 +63,7 @@ Configuration items that support hot reloading and take effect immediately are m
Example
```
# Used for indicate cluster name and distinguish different cluster.
# If you need to modify the cluster name, it's recommended to use 'set configuration "cluster_name=xxx"' sql.
# If you need to modify the cluster name, it's recommended to use [set configuration cluster_name='xxx'] sql.
# Manually modifying configuration file is not recommended, which may cause node restart fail.
# effectiveMode: hot_reload
# Datatype: string
Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/V1.3.x/User-Manual/Maintenance-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ propertyValue
**Example**:

```SQL
IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1;
IoTDB> SET CONFIGURATION a='1',b='1' ON 1;
```

### 2.2 Loading Manually Modified Configuration Files
Expand Down
Loading