This is an automated email from the ASF dual-hosted git repository.
zyk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new e8e2e5ebff [IOTDB-4540] Update mlog parser User-Guide doc (#7524)
e8e2e5ebff is described below
commit e8e2e5ebff95d95186de6582b7353d968d7c1286
Author: Marcos_Zyk <[email protected]>
AuthorDate: Wed Oct 5 18:01:45 2022 +0800
[IOTDB-4540] Update mlog parser User-Guide doc (#7524)
[IOTDB-4540] Update mlog parser User-Guide doc (#7524)
---
docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md | 4 +++-
docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md | 4 +++-
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md
b/docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md
index 985c88c4c0..5e23c388b0 100644
--- a/docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md
+++ b/docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md
@@ -25,7 +25,9 @@ After version 0.12.x, IoTDB encodes metadata files into
binary format.
If you want to parse metadata into a human readable way, you can use this tool
to parse the specified metadata file.
-The tool can parse snapshot files and mlog files.
+Currently, the tool can only parse mlog.bin file.
+
+If the consensus protocol used in cluster for SchemaRegion is RatisConsensus,
IoTDB won't use mlog.bin file to store metadata and won't generate mlog.bin
file.
### How to use
diff --git a/docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md
b/docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md
index 82943f52e4..c7cafa91aa 100644
--- a/docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md
+++ b/docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md
@@ -25,7 +25,9 @@
如果想要解析元数据成人可读的方式，可以使用本工具来解析指定元数据文件。
-该工具可以同时解析 snapshot 文件和 mlog 文件。
+该工具目前仅支持解析 mlog.bin 文件。
+
+在分布式场景下，若 SchemaRegion 的共识协议采用的是 RatisConsensus，IoTDB 不会使用 mlog.bin
文件来存储元数据，也将不会生成 mlog.bin 文件。
### 使用方式
