From 03709cb4283a5bf55026a932d6d828bf67909e4b Mon Sep 17 00:00:00 2001 From: Leto_b Date: Tue, 20 May 2025 09:57:43 +0800 Subject: [PATCH] fix set configuration syntax --- .../Table/Reference/System-Config-Manual.md | 14 +++++++------- .../Table/User-Manual/Maintenance-commands.md | 2 +- .../Tree/Reference/Common-Config-Manual.md | 14 +++++++------- .../Tree/Reference/Modify-Config-Manual.md | 10 +++++----- .../Tree/User-Manual/Maintenance-commands.md | 2 +- .../V1.3.x/Reference/Common-Config-Manual.md | 14 +++++++------- .../V1.3.x/Reference/Modify-Config-Manual.md | 10 +++++----- .../V1.3.x/User-Manual/Maintenance-commands.md | 2 +- .../dev-1.3/Reference/Common-Config-Manual.md | 14 +++++++------- .../dev-1.3/Reference/Modify-Config-Manual.md | 10 +++++----- .../dev-1.3/User-Manual/Maintenance-commands.md | 2 +- .../Reference/System-Config-Manual.md | 14 +++++++------- .../User-Manual/Maintenance-commands.md | 2 +- .../latest/Reference/Common-Config-Manual.md | 14 +++++++------- .../latest/Reference/Modify-Config-Manual.md | 10 +++++----- .../latest/User-Manual/Maintenance-commands.md | 2 +- .../Table/Reference/System-Config-Manual.md | 4 ++-- .../Table/User-Manual/Maintenance-statement.md | 2 +- .../Tree/Reference/Common-Config-Manual.md | 16 ++++++++-------- .../Tree/Reference/Modify-Config-Manual.md | 10 +++++----- .../Tree/User-Manual/Maintenance-statement.md | 2 +- .../V1.3.x/Reference/Common-Config-Manual.md | 14 +++++++------- .../V1.3.x/Reference/Modify-Config-Manual.md | 12 ++++++------ .../V1.3.x/User-Manual/Maintenance-statement.md | 2 +- .../dev-1.3/Reference/Common-Config-Manual.md | 4 ++-- .../dev-1.3/Reference/Modify-Config-Manual.md | 10 +++++----- .../dev-1.3/User-Manual/Maintenance-statement.md | 2 +- .../Reference/System-Config-Manual.md | 14 +++++++------- .../User-Manual/Maintenance-statement.md | 2 +- .../latest/Reference/Common-Config-Manual.md | 14 +++++++------- .../latest/Reference/Modify-Config-Manual.md | 10 +++++----- .../latest/User-Manual/Maintenance-statement.md | 2 +- 32 files changed, 128 insertions(+), 128 deletions(-) diff --git a/src/UserGuide/Master/Table/Reference/System-Config-Manual.md b/src/UserGuide/Master/Table/Reference/System-Config-Manual.md index 0dc2d654f..c0b89501f 100644 --- a/src/UserGuide/Master/Table/Reference/System-Config-Manual.md +++ b/src/UserGuide/Master/Table/Reference/System-Config-Manual.md @@ -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 @@ -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 diff --git a/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md b/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md index 169b77973..2f60fa005 100644 --- a/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md +++ b/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md @@ -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 diff --git a/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md b/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md index 0860323e7..dd3600c4e 100644 --- a/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md +++ b/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md @@ -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 @@ -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 diff --git a/src/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md b/src/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md index ad61e7eb6..e5817862f 100644 --- a/src/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md +++ b/src/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md @@ -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. ``` @@ -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 diff --git a/src/UserGuide/Master/Tree/User-Manual/Maintenance-commands.md b/src/UserGuide/Master/Tree/User-Manual/Maintenance-commands.md index 621c91d16..d6d06d80d 100644 --- a/src/UserGuide/Master/Tree/User-Manual/Maintenance-commands.md +++ b/src/UserGuide/Master/Tree/User-Manual/Maintenance-commands.md @@ -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 diff --git a/src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md b/src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md index 6d77532ef..67f2942aa 100644 --- a/src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md +++ b/src/UserGuide/V1.3.x/Reference/Common-Config-Manual.md @@ -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 @@ -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 diff --git a/src/UserGuide/V1.3.x/Reference/Modify-Config-Manual.md b/src/UserGuide/V1.3.x/Reference/Modify-Config-Manual.md index ad61e7eb6..e5817862f 100644 --- a/src/UserGuide/V1.3.x/Reference/Modify-Config-Manual.md +++ b/src/UserGuide/V1.3.x/Reference/Modify-Config-Manual.md @@ -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. ``` @@ -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 diff --git a/src/UserGuide/V1.3.x/User-Manual/Maintenance-commands.md b/src/UserGuide/V1.3.x/User-Manual/Maintenance-commands.md index 0fe1c2d65..3b580e062 100644 --- a/src/UserGuide/V1.3.x/User-Manual/Maintenance-commands.md +++ b/src/UserGuide/V1.3.x/User-Manual/Maintenance-commands.md @@ -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 diff --git a/src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md b/src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md index 2e6a60278..17c967851 100644 --- a/src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md +++ b/src/UserGuide/dev-1.3/Reference/Common-Config-Manual.md @@ -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 @@ -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 diff --git a/src/UserGuide/dev-1.3/Reference/Modify-Config-Manual.md b/src/UserGuide/dev-1.3/Reference/Modify-Config-Manual.md index ad61e7eb6..e5817862f 100644 --- a/src/UserGuide/dev-1.3/Reference/Modify-Config-Manual.md +++ b/src/UserGuide/dev-1.3/Reference/Modify-Config-Manual.md @@ -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. ``` @@ -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 diff --git a/src/UserGuide/dev-1.3/User-Manual/Maintenance-commands.md b/src/UserGuide/dev-1.3/User-Manual/Maintenance-commands.md index 0fe1c2d65..3b580e062 100644 --- a/src/UserGuide/dev-1.3/User-Manual/Maintenance-commands.md +++ b/src/UserGuide/dev-1.3/User-Manual/Maintenance-commands.md @@ -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 diff --git a/src/UserGuide/latest-Table/Reference/System-Config-Manual.md b/src/UserGuide/latest-Table/Reference/System-Config-Manual.md index 0dc2d654f..c0b89501f 100644 --- a/src/UserGuide/latest-Table/Reference/System-Config-Manual.md +++ b/src/UserGuide/latest-Table/Reference/System-Config-Manual.md @@ -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 @@ -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 diff --git a/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md b/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md index 31c737f4b..ea9533fb4 100644 --- a/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md +++ b/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md @@ -374,7 +374,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 diff --git a/src/UserGuide/latest/Reference/Common-Config-Manual.md b/src/UserGuide/latest/Reference/Common-Config-Manual.md index 53624bb84..10095fd02 100644 --- a/src/UserGuide/latest/Reference/Common-Config-Manual.md +++ b/src/UserGuide/latest/Reference/Common-Config-Manual.md @@ -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 @@ -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 diff --git a/src/UserGuide/latest/Reference/Modify-Config-Manual.md b/src/UserGuide/latest/Reference/Modify-Config-Manual.md index ad61e7eb6..e5817862f 100644 --- a/src/UserGuide/latest/Reference/Modify-Config-Manual.md +++ b/src/UserGuide/latest/Reference/Modify-Config-Manual.md @@ -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. ``` @@ -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 diff --git a/src/UserGuide/latest/User-Manual/Maintenance-commands.md b/src/UserGuide/latest/User-Manual/Maintenance-commands.md index 621c91d16..d6d06d80d 100644 --- a/src/UserGuide/latest/User-Manual/Maintenance-commands.md +++ b/src/UserGuide/latest/User-Manual/Maintenance-commands.md @@ -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 diff --git a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual.md b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual.md index 1b9526c9a..e0a191f78 100644 --- a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual.md +++ b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual.md @@ -38,7 +38,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - 仅允许在第一次启动服务前修改： 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致 ConfigNode/DataNode 无法启动。 - 重启服务生效： ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。 -- 热加载： 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 `load configuration` 或 `set configuration` 命令（SQL）至 IoTDB 使配置生效。 +- 热加载： 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 `load configuration` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。 ## 2. 环境配置项 @@ -116,7 +116,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 | 描述 | 集群名称 | | 类型 | String | | 默认值 | default_cluster | -| 修改方式 | CLI 中执行语句 `set configuration "cluster_name"="xxx"` （xxx为希望修改成的集群名称） | +| 修改方式 | CLI 中执行语句 `set configuration cluster_name='xxx'` （xxx为希望修改成的集群名称） | | 注意 | 此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过`load configuration`的方式热加载。 | ### 3.2 SeedConfigNode 配置 diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md b/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md index ef23b3cd3..ff6e35dbf 100644 --- a/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md +++ b/src/zh/UserGuide/Master/Table/User-Manual/Maintenance-statement.md @@ -375,7 +375,7 @@ propertyValue #### 示例： ```SQL -IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1; +IoTDB> SET CONFIGURATION a='1',b='1' ON 1; ``` ### 2.3 读取手动修改的配置文件 diff --git a/src/zh/UserGuide/Master/Tree/Reference/Common-Config-Manual.md b/src/zh/UserGuide/Master/Tree/Reference/Common-Config-Manual.md index fd127b831..058473fa0 100644 --- a/src/zh/UserGuide/Master/Tree/Reference/Common-Config-Manual.md +++ b/src/zh/UserGuide/Master/Tree/Reference/Common-Config-Manual.md @@ -32,7 +32,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 + **仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致 ConfigNode/DataNode 无法启动。 + **重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。 -+ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load configuration``` 或 `set configuration` 命令（SQL）至 IoTDB 使配置生效。 ++ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load configuration``` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。 ### 1.2 系统配置项 @@ -198,12 +198,12 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 * cluster\_name -| 名字 | cluster\_name | -|:----:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 描述 | 集群名称 | -| 类型 | String | -| 默认值 | default_cluster | -| 修改方式 | CLI 中执行语句 ```set configuration "cluster_name"="xxx"``` （xxx为希望修改成的集群名称） | +| 名字 | cluster\_name | +|:----:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 集群名称 | +| 类型 | String | +| 默认值 | default_cluster | +| 修改方式 | CLI 中执行语句 ```set configuration cluster_name='xxx'``` （xxx为希望修改成的集群名称） | | 注意 | 此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过```load configuration```的方式热加载。 | * time\_partition\_interval @@ -241,7 +241,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 |名字| datanode\_memory\_proportion | |:---:|:----------------------------------------------------------------------| -|描述| 存储引擎、查询引擎、元数据、共识、流处理引擎和空闲内存比例 | +|描述| 存储引擎、查询引擎、元数据、共识、流处理引擎和空闲内存比例 | |类型| Ratio | |默认值| 3:3:1:1:1:1 | |改后生效方式| 重启生效 | diff --git a/src/zh/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md b/src/zh/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md index 4f2ea63ad..972286191 100644 --- a/src/zh/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md +++ b/src/zh/UserGuide/Master/Tree/Reference/Modify-Config-Manual.md @@ -38,21 +38,21 @@ load configuration # 配置项操作语句 设置配置项 ``` -set configuration "key1"="value1" "key2"="value2"... (on nodeId) +set configuration key1 = 'value1' key2 = 'value2'... (on nodeId) ``` ### 示例1 ``` -set configuration "enable_cross_space_compaction"="false" +set configuration enable_cross_space_compaction = 'false' ``` 对集群所有节点永久生效，设置 enable_cross_space_compaction 为 false，并写入到 iotdb-system.properties 中。 ### 示例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 ``` 对 nodeId 为 1 的节点永久生效，设置 enable_cross_space_compaction 为 false，设置 enable_seq_space_compaction 为 false，并写入到 iotdb-system.properties 中。 ### 示例3 ``` -set configuration "enable_cross_space_compaction"="false" "timestamp_precision"="ns" +set configuration enable_cross_space_compaction = 'false' timestamp_precision = 'ns' ``` 对集群所有节点永久生效，设置 enable_cross_space_compaction 为 false，timestamp_precision 为 ns，并写入到 iotdb-system.properties 中。但是，timestamp_precision 是第一次启动后就无法修改的配置项，因此会忽略这个配置项的更新，返回如下。 ``` @@ -63,7 +63,7 @@ Msg: org.apache.iotdb.jdbc.IoTDBSQLException: 301: ignored config items: [timest 示例 ``` # 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 diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/Maintenance-statement.md b/src/zh/UserGuide/Master/Tree/User-Manual/Maintenance-statement.md index 934909aaa..a7bc59c0f 100644 --- a/src/zh/UserGuide/Master/Tree/User-Manual/Maintenance-statement.md +++ b/src/zh/UserGuide/Master/Tree/User-Manual/Maintenance-statement.md @@ -281,7 +281,7 @@ propertyValue #### 示例： ```SQL -IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1; +IoTDB> SET CONFIGURATION a='1',b='1' ON 1; ``` ### 2.3 读取手动修改的配置文件 diff --git a/src/zh/UserGuide/V1.3.x/Reference/Common-Config-Manual.md b/src/zh/UserGuide/V1.3.x/Reference/Common-Config-Manual.md index 25e6c7b78..e4f4c3123 100644 --- a/src/zh/UserGuide/V1.3.x/Reference/Common-Config-Manual.md +++ b/src/zh/UserGuide/V1.3.x/Reference/Common-Config-Manual.md @@ -32,7 +32,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 + **仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致 ConfigNode/DataNode 无法启动。 + **重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。 -+ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load configuration``` 或 `set configuration` 命令（SQL）至 IoTDB 使配置生效。 ++ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load configuration``` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。 ### 系统配置项 @@ -198,12 +198,12 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 * cluster\_name -| 名字 | cluster\_name | -|:----:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 描述 | 集群名称 | -| 类型 | String | -| 默认值 | default_cluster | -| 修改方式 | CLI 中执行语句 ```set configuration "cluster_name"="xxx"``` （xxx为希望修改成的集群名称） | +| 名字 | cluster\_name | +|:----:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 集群名称 | +| 类型 | String | +| 默认值 | default_cluster | +| 修改方式 | CLI 中执行语句 ```set configuration cluster_name='xxx'``` （xxx为希望修改成的集群名称） | | 注意 | 此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过```load configuration```的方式热加载。 | * time\_partition\_interval diff --git a/src/zh/UserGuide/V1.3.x/Reference/Modify-Config-Manual.md b/src/zh/UserGuide/V1.3.x/Reference/Modify-Config-Manual.md index 4f2ea63ad..fc60b6ca1 100644 --- a/src/zh/UserGuide/V1.3.x/Reference/Modify-Config-Manual.md +++ b/src/zh/UserGuide/V1.3.x/Reference/Modify-Config-Manual.md @@ -28,7 +28,7 @@ * 重启后生效 (restart) * 热加载 (hot_reload) # 直接修改配置文件 -可以通过重启或以下命令生效 +可以通过重启或以下命令生效 ## 热加载配置命令 使支持热加载的配置项改动立即生效。 对于已经写在配置文件中修改过的配置项，从配置文件中删除或注释后再进行 load configuration 将恢复默认值。 @@ -38,21 +38,21 @@ load configuration # 配置项操作语句 设置配置项 ``` -set configuration "key1"="value1" "key2"="value2"... (on nodeId) +set configuration key1 = 'value1' key2 = 'value2'... (on nodeId) ``` ### 示例1 ``` -set configuration "enable_cross_space_compaction"="false" +set configuration enable_cross_space_compaction = 'false' ``` 对集群所有节点永久生效，设置 enable_cross_space_compaction 为 false，并写入到 iotdb-system.properties 中。 ### 示例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 ``` 对 nodeId 为 1 的节点永久生效，设置 enable_cross_space_compaction 为 false，设置 enable_seq_space_compaction 为 false，并写入到 iotdb-system.properties 中。 ### 示例3 ``` -set configuration "enable_cross_space_compaction"="false" "timestamp_precision"="ns" +set configuration enable_cross_space_compaction = 'false' timestamp_precision = 'ns' ``` 对集群所有节点永久生效，设置 enable_cross_space_compaction 为 false，timestamp_precision 为 ns，并写入到 iotdb-system.properties 中。但是，timestamp_precision 是第一次启动后就无法修改的配置项，因此会忽略这个配置项的更新，返回如下。 ``` @@ -63,7 +63,7 @@ Msg: org.apache.iotdb.jdbc.IoTDBSQLException: 301: ignored config items: [timest 示例 ``` # 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 diff --git a/src/zh/UserGuide/V1.3.x/User-Manual/Maintenance-statement.md b/src/zh/UserGuide/V1.3.x/User-Manual/Maintenance-statement.md index 42f5a9532..dd30801e0 100644 --- a/src/zh/UserGuide/V1.3.x/User-Manual/Maintenance-statement.md +++ b/src/zh/UserGuide/V1.3.x/User-Manual/Maintenance-statement.md @@ -226,7 +226,7 @@ propertyValue #### 示例： ```SQL -IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1; +IoTDB> SET CONFIGURATION a='1',b='1' ON 1; ``` ### 2.2 读取手动修改的配置文件 diff --git a/src/zh/UserGuide/dev-1.3/Reference/Common-Config-Manual.md b/src/zh/UserGuide/dev-1.3/Reference/Common-Config-Manual.md index 0a8749ded..81e5cead2 100644 --- a/src/zh/UserGuide/dev-1.3/Reference/Common-Config-Manual.md +++ b/src/zh/UserGuide/dev-1.3/Reference/Common-Config-Manual.md @@ -32,7 +32,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 + **仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致 ConfigNode/DataNode 无法启动。 + **重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。 -+ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load configuration``` 或 `set configuration` 命令（SQL）至 IoTDB 使配置生效。 ++ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load configuration``` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。 ### 系统配置项 @@ -203,7 +203,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 | 描述 | 集群名称 | | 类型 | String | | 默认值 | default_cluster | -| 修改方式 | CLI 中执行语句 ```set configuration "cluster_name"="xxx"``` （xxx为希望修改成的集群名称） | +| 修改方式 | CLI 中执行语句 ```set configuration cluster_name='xxx'``` （xxx为希望修改成的集群名称） | | 注意 | 此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过```load configuration```的方式热加载。 | * time\_partition\_interval diff --git a/src/zh/UserGuide/dev-1.3/Reference/Modify-Config-Manual.md b/src/zh/UserGuide/dev-1.3/Reference/Modify-Config-Manual.md index 4f2ea63ad..972286191 100644 --- a/src/zh/UserGuide/dev-1.3/Reference/Modify-Config-Manual.md +++ b/src/zh/UserGuide/dev-1.3/Reference/Modify-Config-Manual.md @@ -38,21 +38,21 @@ load configuration # 配置项操作语句 设置配置项 ``` -set configuration "key1"="value1" "key2"="value2"... (on nodeId) +set configuration key1 = 'value1' key2 = 'value2'... (on nodeId) ``` ### 示例1 ``` -set configuration "enable_cross_space_compaction"="false" +set configuration enable_cross_space_compaction = 'false' ``` 对集群所有节点永久生效，设置 enable_cross_space_compaction 为 false，并写入到 iotdb-system.properties 中。 ### 示例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 ``` 对 nodeId 为 1 的节点永久生效，设置 enable_cross_space_compaction 为 false，设置 enable_seq_space_compaction 为 false，并写入到 iotdb-system.properties 中。 ### 示例3 ``` -set configuration "enable_cross_space_compaction"="false" "timestamp_precision"="ns" +set configuration enable_cross_space_compaction = 'false' timestamp_precision = 'ns' ``` 对集群所有节点永久生效，设置 enable_cross_space_compaction 为 false，timestamp_precision 为 ns，并写入到 iotdb-system.properties 中。但是，timestamp_precision 是第一次启动后就无法修改的配置项，因此会忽略这个配置项的更新，返回如下。 ``` @@ -63,7 +63,7 @@ Msg: org.apache.iotdb.jdbc.IoTDBSQLException: 301: ignored config items: [timest 示例 ``` # 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 diff --git a/src/zh/UserGuide/dev-1.3/User-Manual/Maintenance-statement.md b/src/zh/UserGuide/dev-1.3/User-Manual/Maintenance-statement.md index d26ba5cf9..6e1ab766e 100644 --- a/src/zh/UserGuide/dev-1.3/User-Manual/Maintenance-statement.md +++ b/src/zh/UserGuide/dev-1.3/User-Manual/Maintenance-statement.md @@ -226,7 +226,7 @@ propertyValue #### 示例： ```SQL -IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1; +IoTDB> SET CONFIGURATION a='1',b='1' ON 1; ``` ### 2.2 读取手动修改的配置文件 diff --git a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual.md b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual.md index 1b9526c9a..549f56fe7 100644 --- a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual.md +++ b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual.md @@ -38,7 +38,7 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - 仅允许在第一次启动服务前修改： 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致 ConfigNode/DataNode 无法启动。 - 重启服务生效： ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。 -- 热加载： 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 `load configuration` 或 `set configuration` 命令（SQL）至 IoTDB 使配置生效。 +- 热加载： 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 `load configuration` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。 ## 2. 环境配置项 @@ -111,12 +111,12 @@ IoTDB 配置文件位于 IoTDB 安装目录：`conf`文件夹下。 - cluster_name -| 名字 | cluster_name | -| -------- | ------------------------------------------------------------ | -| 描述 | 集群名称 | -| 类型 | String | -| 默认值 | default_cluster | -| 修改方式 | CLI 中执行语句 `set configuration "cluster_name"="xxx"` （xxx为希望修改成的集群名称） | +| 名字 | cluster_name | +| -------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 集群名称 | +| 类型 | String | +| 默认值 | default_cluster | +| 修改方式 | CLI 中执行语句 `set configuration cluster_name = 'xxx'` （xxx为希望修改成的集群名称） | | 注意 | 此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过`load configuration`的方式热加载。 | ### 3.2 SeedConfigNode 配置 diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md b/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md index ef23b3cd3..ff6e35dbf 100644 --- a/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md +++ b/src/zh/UserGuide/latest-Table/User-Manual/Maintenance-statement.md @@ -375,7 +375,7 @@ propertyValue #### 示例： ```SQL -IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1; +IoTDB> SET CONFIGURATION a='1',b='1' ON 1; ``` ### 2.3 读取手动修改的配置文件 diff --git a/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md b/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md index 6101142c0..058473fa0 100644 --- a/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md +++ b/src/zh/UserGuide/latest/Reference/Common-Config-Manual.md @@ -32,7 +32,7 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 + **仅允许在第一次启动服务前修改：** 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致 ConfigNode/DataNode 无法启动。 + **重启服务生效：** ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。 -+ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load configuration``` 或 `set configuration` 命令（SQL）至 IoTDB 使配置生效。 ++ **热加载：** 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 ```load configuration``` 或 `set configuration key1 = 'value1'` 命令（SQL）至 IoTDB 使配置生效。 ### 1.2 系统配置项 @@ -198,12 +198,12 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。 * cluster\_name -| 名字 | cluster\_name | -|:----:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 描述 | 集群名称 | -| 类型 | String | -| 默认值 | default_cluster | -| 修改方式 | CLI 中执行语句 ```set configuration "cluster_name"="xxx"``` （xxx为希望修改成的集群名称） | +| 名字 | cluster\_name | +|:----:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 描述 | 集群名称 | +| 类型 | String | +| 默认值 | default_cluster | +| 修改方式 | CLI 中执行语句 ```set configuration cluster_name='xxx'``` （xxx为希望修改成的集群名称） | | 注意 | 此修改通过网络分发至每个节点。在网络波动或者有节点宕机的情况下，不保证能够在全部节点修改成功。未修改成功的节点重启时无法加入集群，此时需要手动修改该节点的配置文件中的cluster_name项，再重启。正常情况下，不建议通过手动修改配置文件的方式修改集群名称，不建议通过```load configuration```的方式热加载。 | * time\_partition\_interval diff --git a/src/zh/UserGuide/latest/Reference/Modify-Config-Manual.md b/src/zh/UserGuide/latest/Reference/Modify-Config-Manual.md index 4f2ea63ad..972286191 100644 --- a/src/zh/UserGuide/latest/Reference/Modify-Config-Manual.md +++ b/src/zh/UserGuide/latest/Reference/Modify-Config-Manual.md @@ -38,21 +38,21 @@ load configuration # 配置项操作语句 设置配置项 ``` -set configuration "key1"="value1" "key2"="value2"... (on nodeId) +set configuration key1 = 'value1' key2 = 'value2'... (on nodeId) ``` ### 示例1 ``` -set configuration "enable_cross_space_compaction"="false" +set configuration enable_cross_space_compaction = 'false' ``` 对集群所有节点永久生效，设置 enable_cross_space_compaction 为 false，并写入到 iotdb-system.properties 中。 ### 示例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 ``` 对 nodeId 为 1 的节点永久生效，设置 enable_cross_space_compaction 为 false，设置 enable_seq_space_compaction 为 false，并写入到 iotdb-system.properties 中。 ### 示例3 ``` -set configuration "enable_cross_space_compaction"="false" "timestamp_precision"="ns" +set configuration enable_cross_space_compaction = 'false' timestamp_precision = 'ns' ``` 对集群所有节点永久生效，设置 enable_cross_space_compaction 为 false，timestamp_precision 为 ns，并写入到 iotdb-system.properties 中。但是，timestamp_precision 是第一次启动后就无法修改的配置项，因此会忽略这个配置项的更新，返回如下。 ``` @@ -63,7 +63,7 @@ Msg: org.apache.iotdb.jdbc.IoTDBSQLException: 301: ignored config items: [timest 示例 ``` # 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 diff --git a/src/zh/UserGuide/latest/User-Manual/Maintenance-statement.md b/src/zh/UserGuide/latest/User-Manual/Maintenance-statement.md index 934909aaa..a7bc59c0f 100644 --- a/src/zh/UserGuide/latest/User-Manual/Maintenance-statement.md +++ b/src/zh/UserGuide/latest/User-Manual/Maintenance-statement.md @@ -281,7 +281,7 @@ propertyValue #### 示例： ```SQL -IoTDB> SET CONFIGURATION "a"='1',b='1' ON 1; +IoTDB> SET CONFIGURATION a='1',b='1' ON 1; ``` ### 2.3 读取手动修改的配置文件