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 b42f87f6a7 Rename schema describer scripts and related docs (#8074)
b42f87f6a7 is described below
commit b42f87f6a7fbe68c8ae68df47c8b6d3f22130dfa
Author: ZhaoXin <[email protected]>
AuthorDate: Tue Nov 22 08:57:04 2022 +0800
Rename schema describer scripts and related docs (#8074)
Rename schema describer scripts and related docs (#8074)
---
docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md | 6 +++---
docs/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md | 6 +++---
docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md | 6 +++---
docs/zh/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md | 8 ++++----
.../schema/{SchemaFileSketcher.bat => print-schema-file.bat} | 0
.../tools/schema/{SchemaFileSketcher.sh => print-schema-file.sh} | 0
.../tools/schema/{mLogParser.bat => print-schema-log.bat} | 0
.../resources/tools/schema/{mLogParser.sh => print-schema-log.sh} | 0
.../tools/tsfile/{print-tsfile-sketch.bat => print-tsfile.bat} | 0
.../tools/tsfile/{print-tsfile-sketch.sh => print-tsfile.sh} | 0
.../main/java/org/apache/iotdb/db/tools/schema/MLogParser.java | 2 +-
.../org/apache/iotdb/db/tools/schema/SchemaFileSketchTool.java | 2 +-
12 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md
b/docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md
index 5e23c388b0..cdc55c36c1 100644
--- a/docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md
+++ b/docs/UserGuide/Maintenance-Tools/MLogParser-Tool.md
@@ -23,7 +23,7 @@
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.
+If you want to parse metadata into a human-readable way, you can use this tool
to parse the specified metadata file.
Currently, the tool can only parse mlog.bin file.
@@ -32,9 +32,9 @@ If the consensus protocol used in cluster for SchemaRegion is
RatisConsensus, Io
### How to use
Linux/MacOS
-> ./mLogParser.sh -f /your path/mlog.bin -o /your path/mlog.txt
+> ./print-schema-log.sh -f /your path/mlog.bin -o /your path/mlog.txt
Windows
-> .\mLogParser.bat -f \your path\mlog.bin -o \your path\mlog.txt
+> .\print-schema-log.bat -f \your path\mlog.bin -o \your path\mlog.txt
diff --git a/docs/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md
b/docs/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md
index 07b92c204f..ca5b85ec45 100644
--- a/docs/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md
+++ b/docs/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md
@@ -23,16 +23,16 @@
Since version 0.14.0, IoTDB could store schema into a persistent slotted file.
-If you want to parse schema file into a human readable way, you can use this
tool to parse the specified schema file file.
+If you want to parse schema file into a human-readable way, you can use this
tool to parse the specified schema file.
The tool can sketch .pst file.
### How to use
Linux/MacOS
-> ./SchemaFileSketcher.sh -f your/path/to/schema_file.pst -o
/your/path/to/sketch.txt
+> ./print-schema-file.sh -f your/path/to/schema_file.pst -o
/your/path/to/sketch.txt
Windows
-> ./SchemaFileSketcher.bat -f your/path/to/schema_file.pst -o
/your/path/to/sketch.txt
+> ./print-schema-file.bat -f your/path/to/schema_file.pst -o
/your/path/to/sketch.txt
diff --git a/docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md
b/docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md
index c7cafa91aa..81d567a5fe 100644
--- a/docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md
+++ b/docs/zh/UserGuide/Maintenance-Tools/MLogParser-Tool.md
@@ -23,7 +23,7 @@
0.12.x 版本之后，IoTDB 将元数据文件编码成二进制。
-如果想要解析元数据成人可读的方式，可以使用本工具来解析指定元数据文件。
+如果想要将二进制元数据解析为人可读的字符串格式，可以使用本工具。
该工具目前仅支持解析 mlog.bin 文件。
@@ -32,8 +32,8 @@
### 使用方式
Linux/MacOS
-> ./mLogParser.sh -f /your path/mlog.bin -o /your path/mlog.txt
+> ./print-schema-log.sh -f /your path/mlog.bin -o /your path/mlog.txt
Windows
-> .\mLogParser.bat -f \your path\mlog.bin -o \your path\mlog.txt
+> .\print-schema-log.bat -f \your path\mlog.bin -o \your path\mlog.txt
diff --git a/docs/zh/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md
b/docs/zh/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md
index bc28768056..c3ef7e70e0 100644
--- a/docs/zh/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md
+++ b/docs/zh/UserGuide/Maintenance-Tools/SchemaFileSketch-Tool.md
@@ -23,13 +23,13 @@
自 0.14.0 版本起，IoTDB 将每个 database 下序列的元数据存储为 schema_file.pst 文件。
-如果需要将该文件转为便于阅读的的模式，可以使用本工具来解析指定 schema_file.pst 。
-s
+如果需要将该文件转为便于阅读的的格式，可以使用本工具来解析指定 schema_file.pst 。
+
### 使用方式
Linux/MacOS
-> ./SchemaFileSketcher.sh -f your/path/to/schema_file.pst -o
/your/path/to/sketch.txt
+> ./print-schema-file.sh -f your/path/to/schema_file.pst -o
/your/path/to/sketch.txt
Windows
-> ./SchemaFileSketcher.bat -f your/path/to/schema_file.pst -o
/your/path/to/sketch.txt
+> ./print-schema-file.bat -f your/path/to/schema_file.pst -o
/your/path/to/sketch.txt
diff --git a/server/src/assembly/resources/tools/schema/SchemaFileSketcher.bat
b/server/src/assembly/resources/tools/schema/print-schema-file.bat
similarity index 100%
rename from server/src/assembly/resources/tools/schema/SchemaFileSketcher.bat
rename to server/src/assembly/resources/tools/schema/print-schema-file.bat
diff --git a/server/src/assembly/resources/tools/schema/SchemaFileSketcher.sh
b/server/src/assembly/resources/tools/schema/print-schema-file.sh
similarity index 100%
rename from server/src/assembly/resources/tools/schema/SchemaFileSketcher.sh
rename to server/src/assembly/resources/tools/schema/print-schema-file.sh
diff --git a/server/src/assembly/resources/tools/schema/mLogParser.bat
b/server/src/assembly/resources/tools/schema/print-schema-log.bat
similarity index 100%
rename from server/src/assembly/resources/tools/schema/mLogParser.bat
rename to server/src/assembly/resources/tools/schema/print-schema-log.bat
diff --git a/server/src/assembly/resources/tools/schema/mLogParser.sh
b/server/src/assembly/resources/tools/schema/print-schema-log.sh
similarity index 100%
rename from server/src/assembly/resources/tools/schema/mLogParser.sh
rename to server/src/assembly/resources/tools/schema/print-schema-log.sh
diff --git a/server/src/assembly/resources/tools/tsfile/print-tsfile-sketch.bat
b/server/src/assembly/resources/tools/tsfile/print-tsfile.bat
similarity index 100%
rename from server/src/assembly/resources/tools/tsfile/print-tsfile-sketch.bat
rename to server/src/assembly/resources/tools/tsfile/print-tsfile.bat
diff --git a/server/src/assembly/resources/tools/tsfile/print-tsfile-sketch.sh
b/server/src/assembly/resources/tools/tsfile/print-tsfile.sh
old mode 100755
new mode 100644
similarity index 100%
rename from server/src/assembly/resources/tools/tsfile/print-tsfile-sketch.sh
rename to server/src/assembly/resources/tools/tsfile/print-tsfile.sh
diff --git
a/server/src/main/java/org/apache/iotdb/db/tools/schema/MLogParser.java
b/server/src/main/java/org/apache/iotdb/db/tools/schema/MLogParser.java
index 18b15a95ff..af3bd24fed 100644
--- a/server/src/main/java/org/apache/iotdb/db/tools/schema/MLogParser.java
+++ b/server/src/main/java/org/apache/iotdb/db/tools/schema/MLogParser.java
@@ -42,7 +42,7 @@ import java.io.IOException;
public class MLogParser {
private static final Logger logger =
LoggerFactory.getLogger(MLogParser.class);
- private static final String MLOG_CLI_PREFIX = "MlogParser";
+ private static final String MLOG_CLI_PREFIX = "print-schema-log";
private static final String FILE_ARGS = "f";
private static final String FILE_NAME = "mlog file";
diff --git
a/server/src/main/java/org/apache/iotdb/db/tools/schema/SchemaFileSketchTool.java
b/server/src/main/java/org/apache/iotdb/db/tools/schema/SchemaFileSketchTool.java
index eb40d38b60..b4d9332d12 100644
---
a/server/src/main/java/org/apache/iotdb/db/tools/schema/SchemaFileSketchTool.java
+++
b/server/src/main/java/org/apache/iotdb/db/tools/schema/SchemaFileSketchTool.java
@@ -44,7 +44,7 @@ import java.io.PrintWriter;
public class SchemaFileSketchTool {
private static final Logger logger =
LoggerFactory.getLogger(SchemaFileSketchTool.class);
- private static final String SFST_CLI_PREFIX = "SchemaFileSketchTool";
+ private static final String SFST_CLI_PREFIX = "print-schema-file";
private static final String FILE_ARGS = "f";
private static final String FILE_NAME = "schema file";
