diff --git a/src/UserGuide/Master/stage/Maintenance-Tools/Overlap-Validation-And-Repair-Tool.md b/src/UserGuide/Master/stage/Maintenance-Tools/Overlap-Validation-And-Repair-Tool.md new file mode 100644 index 00000000..5305fc46 --- /dev/null +++ b/src/UserGuide/Master/stage/Maintenance-Tools/Overlap-Validation-And-Repair-Tool.md @@ -0,0 +1,42 @@ + + +# Overlap validation and repair tool + +The Overlap Validation And Repair tool is used to validate the resource files in sequence space, and repair overlaps. + +The validation function can be run in any scenario. Confirmation is required after overlapping files are found. Typing 'y' will perform the repair. + +**The repair function must be run when corresponding DataNode is stopped and there are no unfinished compaction task in all data dirs.** +To make sure there are no unfinished compaction tasks, you can modify the config files to set enable compaction items to false, and restart DataNode waiting compaction recover task to finish. +Then stop the DataNode and run this tool. +## Usage +```shell +#MacOs or Linux +./check-overlap-sequence-files-and-repair.sh [sequence_data_dir1] [sequence_data_dir2]... +# Windows +.\check-overlap-sequence-files-and-repair.bat [sequence_data_dir1] [sequence_data_dir2]... +``` +## Example +```shell +./check-overlap-sequence-files-and-repair.sh /data1/sequence/ /data2/sequence +``` +This example validate two data dirs: /data1/sequence/, /data2/sequence. \ No newline at end of file diff --git a/src/zh/UserGuide/Master/stage/Maintenance-Tools/Overlap-Validation-And-Repair-Tool.md b/src/zh/UserGuide/Master/stage/Maintenance-Tools/Overlap-Validation-And-Repair-Tool.md new file mode 100644 index 00000000..c08f119d --- /dev/null +++ b/src/zh/UserGuide/Master/stage/Maintenance-Tools/Overlap-Validation-And-Repair-Tool.md @@ -0,0 +1,41 @@ + + +# Overlap validation and repair 工具 + +Overlap Validation And Repair 工具用于验证顺序空间内 tsfile 的 resource 文件的重叠情况并进行修复。 + +验证功能可以在任意场景下运行,在找出所有存在重叠的文件后,需要输入 'y' 以确认是否进行修复。 + +**修复功能必须在相关的 DataNode 停止之后执行,且对应的数据目录中不存在未完成的合并任务。** +为了确保没有尚未完成的合并任务,你可以修改配置文件中开启合并相关的配置项为 false,然后重启 DataNode 并等待合并恢复任务的完成,停止 DataNode,再运行这个工具。 +## 使用方法 +```shell +#MacOs or Linux +./check-overlap-sequence-files-and-repair.sh [sequence_data_dir1] [sequence_data_dir2]... +# Windows +.\check-overlap-sequence-files-and-repair.bat [sequence_data_dir1] [sequence_data_dir2]... +``` +## 示例 +```shell +./check-overlap-sequence-files-and-repair.sh /data1/sequence/ /data2/sequence +``` +这个示例指定了配置的两个数据目录进行扫描: /data1/sequence/, /data2/sequence。