This is an automated email from the ASF dual-hosted git repository.
HTHou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new cdf74af6 Add Repair Data Partition Table doc for V2.0.11 tree model
(#1209)
cdf74af6 is described below
commit cdf74af688230377f227877ae9386383df60a36f
Author: leto-bbq <[email protected]>
AuthorDate: Fri Sep 11 17:42:51 2026 +0800
Add Repair Data Partition Table doc for V2.0.11 tree model (#1209)
---
src/.vuepress/sidebar/V2.0.x/en-Tree.ts | 1 +
src/.vuepress/sidebar/V2.0.x/zh-Tree.ts | 1 +
.../Basic-Concept/Repair-Data-Partition_apache.md | 90 ++++++++++++++++++++++
.../Basic-Concept/Repair-Data-Partition_apache.md | 90 ++++++++++++++++++++++
.../Basic-Concept/Repair-Data-Partition_apache.md | 90 ++++++++++++++++++++++
.../Basic-Concept/Repair-Data-Partition_apache.md | 90 ++++++++++++++++++++++
6 files changed, 362 insertions(+)
diff --git a/src/.vuepress/sidebar/V2.0.x/en-Tree.ts
b/src/.vuepress/sidebar/V2.0.x/en-Tree.ts
index d8927f36..1b72fc0c 100644
--- a/src/.vuepress/sidebar/V2.0.x/en-Tree.ts
+++ b/src/.vuepress/sidebar/V2.0.x/en-Tree.ts
@@ -102,6 +102,7 @@ export const enSidebar = {
children: [
{ text: 'Delete Data', link: 'Delete-Data' },
{ text: 'TTL Delete Data', link: 'TTL-Delete' },
+ { text: 'Repair Data Partition Table', link:
'Repair-Data-Partition_apache' },
],
},
],
diff --git a/src/.vuepress/sidebar/V2.0.x/zh-Tree.ts
b/src/.vuepress/sidebar/V2.0.x/zh-Tree.ts
index e0489910..1c618c14 100644
--- a/src/.vuepress/sidebar/V2.0.x/zh-Tree.ts
+++ b/src/.vuepress/sidebar/V2.0.x/zh-Tree.ts
@@ -96,6 +96,7 @@ export const zhSidebar = {
children: [
{ text: '数据删除', link: 'Delete-Data' },
{ text: '数据保留时间', link: 'TTL-Delete' },
+ { text: '修复数据分区表', link: 'Repair-Data-Partition_apache' },
],
},
],
diff --git
a/src/UserGuide/Master/Tree/Basic-Concept/Repair-Data-Partition_apache.md
b/src/UserGuide/Master/Tree/Basic-Concept/Repair-Data-Partition_apache.md
new file mode 100644
index 00000000..88dd3ae5
--- /dev/null
+++ b/src/UserGuide/Master/Tree/Basic-Concept/Repair-Data-Partition_apache.md
@@ -0,0 +1,90 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+# Repair Data Partition Table
+
+In extreme cases, such as ConfigNode metadata loss or partial data partition
information corruption, IoTDB provides the ability to manually repair the data
partition table starting from V2\.0\.11. This feature is used to recover
missing data partition information in the ConfigNode, and it is recommended to
use it only after confirming that the data partition table is abnormal.
+
+## 1. Executing the Repair Operation
+
+When all ConfigNodes and DataNodes are running normally, execute the following
SQL to trigger the repair process:
+
+```SQL
+REPAIR DATA PARTITION TABLE;
+```
+
+The system will automatically scan the data partition information on each
DataNode and check whether there are missing records in the data partition
table of the ConfigNode. If any missing records are found, the system will
repair them automatically.
+
+> Note: Before executing the repair operation, please make sure that both
ConfigNodes and DataNodes are running normally.
+>
+
+
+## 2. Viewing the Repair Progress
+
+After executing `REPAIR DATA PARTITION TABLE`, you can view the real-time
progress of the repair task with the following SQL:
+
+```SQL
+SHOW REPAIR DATA PARTITION TABLE PROGRESS;
+```
+
+After executing the SQL above, the system will return a result set containing
the following fields:
+
+|Field|Description|
+|---|---|
+|`Status`|The status of the current repair task|
+|`Progress(%)`|The overall progress percentage of the current repair task|
+|`Message`|Detailed information about the current status or progress|
+
+During the task execution, you may see results like:
+
+```SQL
++----------------------------+-----------+----------------------------------------------------+
+| Status|Progress(%)|
Message|
++----------------------------+-----------+----------------------------------------------------+
+| COLLECT_EARLIEST_TIMESLOTS| 0.0| DataPartitionTable integrity
check progress: 0.0%|
++----------------------------+-----------+----------------------------------------------------+
+```
+
+If there is no repair task currently running, the system will return the
`IDLE` status, for example:
+
+```SQL
++------+-----------+-------------------------------------------------------+
+|Status|Progress(%)| Message|
++------+-----------+-------------------------------------------------------+
+| IDLE| 0.0|No running DataPartitionTable integrity check procedure|
++------+-----------+-------------------------------------------------------+
+```
+
+## 3. Configuration Parameters (Optional)
+
+To prevent the file scanning process from affecting normal online business,
IoTDB provides the following two configurable parameters to control concurrent
processing capability and read throttling. You can configure them as needed in
`iotdb-system.properties` according to your actual environment.
+
+|Parameter|Description|Default Value|
+|---|---|---|
+|`partition_table_recover_worker_num`|The number of threads for parallel
retrieval|`10`|
+|`partition_table_recover_max_read_mb_per_sec`|The maximum read rate per
second, in MB/s|`10`|
+
+- During the data partition table repair process,
`partition_table_recover_worker_num` is used to control the number of
concurrent checking threads. In production environments, it is recommended to
reserve some thread resources for the main functions of IoTDB, and this
parameter value should not exceed the number of CPU cores.
+
+- In production environments, it is recommended to set an upper limit on the
read rate through `partition_table_recover_max_read_mb_per_sec` to avoid the
repair operation placing excessive pressure on business reads and writes.
+
+> Note: The above parameters are all optional, with a default value of `10`;
the value must be greater than `0`, and changes take effect after restart.
+>
diff --git a/src/UserGuide/latest/Basic-Concept/Repair-Data-Partition_apache.md
b/src/UserGuide/latest/Basic-Concept/Repair-Data-Partition_apache.md
new file mode 100644
index 00000000..88dd3ae5
--- /dev/null
+++ b/src/UserGuide/latest/Basic-Concept/Repair-Data-Partition_apache.md
@@ -0,0 +1,90 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+# Repair Data Partition Table
+
+In extreme cases, such as ConfigNode metadata loss or partial data partition
information corruption, IoTDB provides the ability to manually repair the data
partition table starting from V2\.0\.11. This feature is used to recover
missing data partition information in the ConfigNode, and it is recommended to
use it only after confirming that the data partition table is abnormal.
+
+## 1. Executing the Repair Operation
+
+When all ConfigNodes and DataNodes are running normally, execute the following
SQL to trigger the repair process:
+
+```SQL
+REPAIR DATA PARTITION TABLE;
+```
+
+The system will automatically scan the data partition information on each
DataNode and check whether there are missing records in the data partition
table of the ConfigNode. If any missing records are found, the system will
repair them automatically.
+
+> Note: Before executing the repair operation, please make sure that both
ConfigNodes and DataNodes are running normally.
+>
+
+
+## 2. Viewing the Repair Progress
+
+After executing `REPAIR DATA PARTITION TABLE`, you can view the real-time
progress of the repair task with the following SQL:
+
+```SQL
+SHOW REPAIR DATA PARTITION TABLE PROGRESS;
+```
+
+After executing the SQL above, the system will return a result set containing
the following fields:
+
+|Field|Description|
+|---|---|
+|`Status`|The status of the current repair task|
+|`Progress(%)`|The overall progress percentage of the current repair task|
+|`Message`|Detailed information about the current status or progress|
+
+During the task execution, you may see results like:
+
+```SQL
++----------------------------+-----------+----------------------------------------------------+
+| Status|Progress(%)|
Message|
++----------------------------+-----------+----------------------------------------------------+
+| COLLECT_EARLIEST_TIMESLOTS| 0.0| DataPartitionTable integrity
check progress: 0.0%|
++----------------------------+-----------+----------------------------------------------------+
+```
+
+If there is no repair task currently running, the system will return the
`IDLE` status, for example:
+
+```SQL
++------+-----------+-------------------------------------------------------+
+|Status|Progress(%)| Message|
++------+-----------+-------------------------------------------------------+
+| IDLE| 0.0|No running DataPartitionTable integrity check procedure|
++------+-----------+-------------------------------------------------------+
+```
+
+## 3. Configuration Parameters (Optional)
+
+To prevent the file scanning process from affecting normal online business,
IoTDB provides the following two configurable parameters to control concurrent
processing capability and read throttling. You can configure them as needed in
`iotdb-system.properties` according to your actual environment.
+
+|Parameter|Description|Default Value|
+|---|---|---|
+|`partition_table_recover_worker_num`|The number of threads for parallel
retrieval|`10`|
+|`partition_table_recover_max_read_mb_per_sec`|The maximum read rate per
second, in MB/s|`10`|
+
+- During the data partition table repair process,
`partition_table_recover_worker_num` is used to control the number of
concurrent checking threads. In production environments, it is recommended to
reserve some thread resources for the main functions of IoTDB, and this
parameter value should not exceed the number of CPU cores.
+
+- In production environments, it is recommended to set an upper limit on the
read rate through `partition_table_recover_max_read_mb_per_sec` to avoid the
repair operation placing excessive pressure on business reads and writes.
+
+> Note: The above parameters are all optional, with a default value of `10`;
the value must be greater than `0`, and changes take effect after restart.
+>
diff --git
a/src/zh/UserGuide/Master/Tree/Basic-Concept/Repair-Data-Partition_apache.md
b/src/zh/UserGuide/Master/Tree/Basic-Concept/Repair-Data-Partition_apache.md
new file mode 100644
index 00000000..034f4572
--- /dev/null
+++ b/src/zh/UserGuide/Master/Tree/Basic-Concept/Repair-Data-Partition_apache.md
@@ -0,0 +1,90 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+# 修复数据分区表
+
+在极端情况下，例如 ConfigNode 元数据丢失或部分数据分区信息损坏，IoTDB 自 V2\.0\.11
起提供手动修复数据分区表的能力。该功能用于恢复 ConfigNode 中缺失的数据分区信息，建议在确认存在数据分区表异常后使用。
+
+## 1. 执行修复操作
+
+当所有 ConfigNode 和 DataNode 均正常运行后，执行以下 SQL 触发修复流程：
+
+```SQL
+REPAIR DATA PARTITION TABLE;
+```
+
+系统将自动扫描各 DataNode 节点中的数据分区信息，并检查 ConfigNode 的数据分区表中是否存在缺失记录。若发现缺失，系统会自动进行修复。
+
+> 注意：执行修复操作前，请确保 ConfigNode 与 DataNode 均处于正常运行状态。
+>
+
+
+## 2. 查看修复进度
+
+在执行 `REPAIR DATA PARTITION TABLE` 后，可以通过以下 SQL 查看修复任务的实时进度：
+
+```SQL
+SHOW REPAIR DATA PARTITION TABLE PROGRESS;
+```
+
+执行上述 SQL 后，系统将返回包含以下字段的结果集：
+
+|字段名|说明|
+|---|---|
+|`Status`|当前修复任务的状态|
+|`Progress(%)`|当前修复任务的整体进度百分比|
+|`Message`|当前状态或进度的详细信息|
+
+任务执行过程中可能看到类似结果：
+
+```SQL
++----------------------------+-----------+----------------------------------------------------+
+| Status|Progress(%)|
Message|
++----------------------------+-----------+----------------------------------------------------+
+| COLLECT_EARLIEST_TIMESLOTS| 0.0| DataPartitionTable integrity
check progress: 0.0%|
++----------------------------+-----------+----------------------------------------------------+
+```
+
+如果系统当前没有正在执行的修复任务，则返回 `IDLE` 状态，如：
+
+```SQL
++------+-----------+-------------------------------------------------------+
+|Status|Progress(%)| Message|
++------+-----------+-------------------------------------------------------+
+| IDLE| 0.0|No running DataPartitionTable integrity check procedure|
++------+-----------+-------------------------------------------------------+
+```
+
+## 3. 配置参数（可选）
+
+为避免扫描文件过程对线上正常业务造成影响，IoTDB 提供了以下两个可配置参数，用于控制并发处理能力与读取限流。您可以根据实际环境在
`iotdb-system.properties` 中按需配置。
+
+|参数名|说明|默认值|
+|---|---|---|
+|`partition_table_recover_worker_num`|并行检索的线程数量|`10`|
+|`partition_table_recover_max_read_mb_per_sec`|每秒最大读取速率，单位为 MB/s|`10`|
+
+- 数据分区表修复过程中，会使用 `partition_table_recover_worker_num` 控制并发检查的线程数。在生产环境中，建议为
IoTDB 主要功能预留部分线程资源，该参数值不宜超过 CPU 核数。
+
+- 在生产环境中，建议通过 `partition_table_recover_max_read_mb_per_sec`
设置读取速率上限，避免修复操作对业务读写造成过大压力。
+
+> 注意：以上参数均为可选项，默认值为 `10`；取值须大于 `0`，修改后重启生效。
+>
diff --git
a/src/zh/UserGuide/latest/Basic-Concept/Repair-Data-Partition_apache.md
b/src/zh/UserGuide/latest/Basic-Concept/Repair-Data-Partition_apache.md
new file mode 100644
index 00000000..034f4572
--- /dev/null
+++ b/src/zh/UserGuide/latest/Basic-Concept/Repair-Data-Partition_apache.md
@@ -0,0 +1,90 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+# 修复数据分区表
+
+在极端情况下，例如 ConfigNode 元数据丢失或部分数据分区信息损坏，IoTDB 自 V2\.0\.11
起提供手动修复数据分区表的能力。该功能用于恢复 ConfigNode 中缺失的数据分区信息，建议在确认存在数据分区表异常后使用。
+
+## 1. 执行修复操作
+
+当所有 ConfigNode 和 DataNode 均正常运行后，执行以下 SQL 触发修复流程：
+
+```SQL
+REPAIR DATA PARTITION TABLE;
+```
+
+系统将自动扫描各 DataNode 节点中的数据分区信息，并检查 ConfigNode 的数据分区表中是否存在缺失记录。若发现缺失，系统会自动进行修复。
+
+> 注意：执行修复操作前，请确保 ConfigNode 与 DataNode 均处于正常运行状态。
+>
+
+
+## 2. 查看修复进度
+
+在执行 `REPAIR DATA PARTITION TABLE` 后，可以通过以下 SQL 查看修复任务的实时进度：
+
+```SQL
+SHOW REPAIR DATA PARTITION TABLE PROGRESS;
+```
+
+执行上述 SQL 后，系统将返回包含以下字段的结果集：
+
+|字段名|说明|
+|---|---|
+|`Status`|当前修复任务的状态|
+|`Progress(%)`|当前修复任务的整体进度百分比|
+|`Message`|当前状态或进度的详细信息|
+
+任务执行过程中可能看到类似结果：
+
+```SQL
++----------------------------+-----------+----------------------------------------------------+
+| Status|Progress(%)|
Message|
++----------------------------+-----------+----------------------------------------------------+
+| COLLECT_EARLIEST_TIMESLOTS| 0.0| DataPartitionTable integrity
check progress: 0.0%|
++----------------------------+-----------+----------------------------------------------------+
+```
+
+如果系统当前没有正在执行的修复任务，则返回 `IDLE` 状态，如：
+
+```SQL
++------+-----------+-------------------------------------------------------+
+|Status|Progress(%)| Message|
++------+-----------+-------------------------------------------------------+
+| IDLE| 0.0|No running DataPartitionTable integrity check procedure|
++------+-----------+-------------------------------------------------------+
+```
+
+## 3. 配置参数（可选）
+
+为避免扫描文件过程对线上正常业务造成影响，IoTDB 提供了以下两个可配置参数，用于控制并发处理能力与读取限流。您可以根据实际环境在
`iotdb-system.properties` 中按需配置。
+
+|参数名|说明|默认值|
+|---|---|---|
+|`partition_table_recover_worker_num`|并行检索的线程数量|`10`|
+|`partition_table_recover_max_read_mb_per_sec`|每秒最大读取速率，单位为 MB/s|`10`|
+
+- 数据分区表修复过程中，会使用 `partition_table_recover_worker_num` 控制并发检查的线程数。在生产环境中，建议为
IoTDB 主要功能预留部分线程资源，该参数值不宜超过 CPU 核数。
+
+- 在生产环境中，建议通过 `partition_table_recover_max_read_mb_per_sec`
设置读取速率上限，避免修复操作对业务读写造成过大压力。
+
+> 注意：以上参数均为可选项，默认值为 `10`；取值须大于 `0`，修改后重启生效。
+>
