Skip to content

fix-set-configuration-syntax-in-config-manual #848

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 2 commits into from
Aug 28, 2025
Merged

fix-set-configuration-syntax-in-config-manual #848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bed403
fix-set-configuration-syntax-in-config-manual
leto-b Aug 11, 2025
ef67536
fix-set-configuration-syntax-in-config-manual
leto-b Aug 11, 2025
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
4 changes: 2 additions & 2 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 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

Expand Down Expand Up @@ -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 manually modifying the configuration file, nor is it recommended to hot load through the load configuration method. |

* time\_partition\_interval
Expand Down
4 changes: 2 additions & 2 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 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

Expand Down Expand Up @@ -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 manually modifying the configuration file, nor is it recommended to hot load through the load configuration method. |

* time\_partition\_interval
Expand Down
4 changes: 2 additions & 2 deletions src/UserGuide/dev-1.3/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 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

Expand Down Expand Up @@ -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 manually modifying the configuration file, nor is it recommended to hot load through the load configuration method. |

* time\_partition\_interval
Expand Down
4 changes: 2 additions & 2 deletions src/UserGuide/latest/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 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

Expand Down Expand Up @@ -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 manually modifying the configuration file, nor is it recommended to hot load through the load configuration method. |

* time\_partition\_interval
Expand Down
Loading