You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ta...@apache.org on 2023/04/27 13:19:06 UTC

[iotdb] 01/01: add dn_consensus_dir doc

This is an automated email from the ASF dual-hosted git repository.

tanxinyu pushed a commit to branch updaate_consensus_dir_doc
in repository https://gitbox.apache.org/repos/asf/iotdb.git

commit 8ded0d04344ac8ca14fc43d5ffacca8bee50f455
Author: OneSizeFitQuorum <ta...@apache.org>
AuthorDate: Thu Apr 27 21:18:44 2023 +0800

    add dn_consensus_dir doc
    
    Signed-off-by: OneSizeFitQuorum <ta...@apache.org>
---
 docs/UserGuide/QuickStart/Files.md                 |  2 +-
 docs/UserGuide/Reference/DataNode-Config-Manual.md | 14 ++++++-------
 docs/zh/UserGuide/QuickStart/Files.md              |  2 +-
 .../UserGuide/Reference/DataNode-Config-Manual.md  | 23 +++++++++++++++-------
 4 files changed, 25 insertions(+), 16 deletions(-)

diff --git a/docs/UserGuide/QuickStart/Files.md b/docs/UserGuide/QuickStart/Files.md
index 3f514a0443..4e79555bbe 100644
--- a/docs/UserGuide/QuickStart/Files.md
+++ b/docs/UserGuide/QuickStart/Files.md
@@ -118,7 +118,7 @@ An example of the configuration items are as follows:
 dn_system_dir = $IOTDB_HOME/data/datanode/system
 dn_data_dirs = /data1/datanode/data, /data2/datanode/data, /data3/datanode/data 
 dn_multi_dir_strategy=MaxDiskUsableSpaceFirstStrategy
-dn_wal_dir= $IOTDB_HOME/data/datanode/wal
+dn_wal_dirs= $IOTDB_HOME/data/datanode/wal
 ```
 After setting the configuration, the system will:
 
diff --git a/docs/UserGuide/Reference/DataNode-Config-Manual.md b/docs/UserGuide/Reference/DataNode-Config-Manual.md
index e8a8770045..5a71e0ec8b 100644
--- a/docs/UserGuide/Reference/DataNode-Config-Manual.md
+++ b/docs/UserGuide/Reference/DataNode-Config-Manual.md
@@ -291,16 +291,16 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
 | Description | The directories of data files. Multiple directories are separated by comma. The starting directory of the relative path is related to the operating system. It is recommended to use an absolute path. If the path does not exist, the system will automatically create it. |
 |    Type     | String[]                                                                                                                                                                                                                                                                    |
 |   Default   | data/datanode/data (Windows: data\\datanode\\data)                                                                                                                                                                                                                          |
-|  Effective  | hot-load                                                                                                                                                                                                                                                                     |
+|  Effective  | After restarting system                                                                                                                                                                                                                                                     |
 
 * dn\_multi\_dir\_strategy
 
-|Name| dn\_multi\_dir\_strategy |
-|:---:|:---|
-|Description| IoTDB's strategy for selecting directories for TsFile in tsfile_dir. You can use a simple class name or a full name of the class. The system provides the following three strategies: <br>1. SequenceStrategy: IoTDB selects the directory from tsfile\_dir in order, traverses all the directories in tsfile\_dir in turn, and keeps counting;<br>2. MaxDiskUsableSpaceFirstStrategy: IoTDB first selects the directory with the largest free disk space in tsfile\_dir;<br>3. MinFolderOccup [...]
-|Type|String|
-|Default| MaxDiskUsableSpaceFirstStrategy |
-|Effective|hot-load|
+|    Name     | dn\_multi\_dir\_strategy                                                                                                                                                                                                                                                                                                                                                                                                                                                                     [...]
+|:-----------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
+| Description | IoTDB's strategy for selecting directories for TsFile in tsfile_dir. You can use a simple class name or a full name of the class. The system provides the following three strategies: <br>1. SequenceStrategy: IoTDB selects the directory from tsfile\_dir in order, traverses all the directories in tsfile\_dir in turn, and keeps counting;<br>2. MaxDiskUsableSpaceFirstStrategy: IoTDB first selects the directory with the largest free disk space in tsfile\_dir;<br>3. MinFolderOcc [...]
+|    Type     | String                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       [...]
+|   Default   | MaxDiskUsableSpaceFirstStrategy                                                                                                                                                                                                                                                                                                                                                                                                                                                              [...]
+|  Effective  | hot-load                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     [...]
 
 * dn\_consensus\_dir
 
diff --git a/docs/zh/UserGuide/QuickStart/Files.md b/docs/zh/UserGuide/QuickStart/Files.md
index ea26ca3841..419587774b 100644
--- a/docs/zh/UserGuide/QuickStart/Files.md
+++ b/docs/zh/UserGuide/QuickStart/Files.md
@@ -113,7 +113,7 @@ IoTDB 涉及到的所有数据目录路径有:data_dirs, multi_dir_strategy, s
 dn_system_dir = $IOTDB_HOME/data/datanode/system
 dn_data_dirs = /data1/datanode/data, /data2/datanode/data, /data3/datanode/data 
 dn_multi_dir_strategy=MaxDiskUsableSpaceFirstStrategy
-dn_wal_dir= $IOTDB_HOME/data/datanode/wal
+dn_wal_dirs= $IOTDB_HOME/data/datanode/wal
 ```
 按照上述配置,系统会:
 
diff --git a/docs/zh/UserGuide/Reference/DataNode-Config-Manual.md b/docs/zh/UserGuide/Reference/DataNode-Config-Manual.md
index 5ca0a4a1dc..4e37bf56a3 100644
--- a/docs/zh/UserGuide/Reference/DataNode-Config-Manual.md
+++ b/docs/zh/UserGuide/Reference/DataNode-Config-Manual.md
@@ -40,7 +40,7 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件,均位于 IoTDB 
 
 * MAX\_HEAP\_SIZE
 
-|名字|MAX\_HEAP\_SIZE|
+|名字|MAX\_HEAP\_SIZE|q
 |:---:|:---|
 |描述|IoTDB 能使用的最大堆内存大小 |
 |类型|String|
@@ -274,7 +274,7 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件,均位于 IoTDB 
 |   描述   | IoTDB 元数据存储路径,默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关,建议使用绝对路径。 |
 |   类型   | String                                                              |
 |  默认值   | data/datanode/system(Windows:data\\datanode\\system)                |
-| 改后生效方式 | 热加载                                                                |
+| 改后生效方式 | 重启服务生效                                                                    |
 
 * dn\_data\_dirs
 
@@ -283,7 +283,7 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件,均位于 IoTDB 
 |   描述   | IoTDB 数据存储路径,默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关,建议使用绝对路径。 |
 |   类型   | String                                                             |
 |  默认值   | data/datanode/data(Windows:data\\datanode\\data)                   |
-| 改后生效方式 | 热加载                                                               |
+| 改后生效方式 | 重启服务生效                                                                   |
 
 * dn\_multi\_dir\_strategy
 
@@ -294,6 +294,15 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件,均位于 IoTDB 
 |  默认值   | MaxDiskUsableSpaceFirstStrategy                                                                                                                                                                                                                                                                                                                                                                                                                                                                   [...]
 | 改后生效方式 | 热加载                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               [...]
 
+* dn\_consensus\_dir
+
+|   名字   | dn\_consensus\_dir                                                       |
+|:------:|:-------------------------------------------------------------------------|
+|   描述   | IoTDB 共识层日志存储路径,默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关,建议使用绝对路径。    |
+|   类型   | String                                                                   |
+|  默认值   | data/datanode/consensus(Windows:data\\datanode\\consensus)               |
+| 改后生效方式 | 重启服务生效                                                                         |
+
 * dn\_wal\_dir
 
 |   名字   | dn\_wal\_dir                                                         |
@@ -301,7 +310,7 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件,均位于 IoTDB 
 |   描述   | IoTDB 写前日志存储路径,默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关,建议使用绝对路径。 |
 |   类型   | String                                                               |
 |  默认值   | data/datanode/wal(Windows:data\\datanode\\wal)                       |
-| 改后生效方式 | 热加载                                                                 |
+| 改后生效方式 | 重启服务生效                                                                     |
 
 * dn\_tracing\_dir
 
@@ -310,7 +319,7 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件,均位于 IoTDB 
 |   描述   | IoTDB 追踪根目录路径,默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关,建议使用绝对路径。 |
 |   类型   | String                                                              |
 |  默认值   | datanode/tracing                                                    |
-| 改后生效方式 | 热加载                                                                |
+| 改后生效方式 | 重启服务生效                                                                    |
 
 * dn\_sync\_dir
 
@@ -318,8 +327,8 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件,均位于 IoTDB 
 |:------:|:----------------------------------------------------------------------|
 |   描述   | IoTDB sync 存储路径,默认存放在和 sbin 目录同级的 data 目录下。相对路径的起始目录与操作系统相关,建议使用绝对路径。 |
 |   类型   | String                                                                |
-|  默认值   | data/datanode/sync                        |
-| 改后生效方式 | 热加载                                                                  |
+|  默认值   | data/datanode/sync                                                    |
+| 改后生效方式 | 重启服务生效                                                                      |
 
 #### Metric 配置