Skip to content

Commit 50e0b60

Browse files
authored
Repair data docs (#195)
1 parent cf84563 commit 50e0b60

File tree

22 files changed

+332
-3
lines changed

22 files changed

+332
-3
lines changed

src/UserGuide/Master/Deployment-and-Maintenance/Security-Management_apache.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,18 @@ Eg: IoTDB > FULL MERGE
497497
Eg: IoTDB > CLEAR CACHE
498498
```
499499

500+
- START REPAIR DATA
501+
502+
```sql
503+
Eg: IoTDB > START REPAIR DATA
504+
```
505+
506+
- STOP REPAIR DATA
507+
508+
```sql
509+
Eg: IoTDB > STOP REPAIR DATA
510+
```
511+
500512
- SET SYSTEM TO READONLY / WRITABLE
501513

502514
```

src/UserGuide/Master/Deployment-and-Maintenance/Security-Management_timecho.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,18 @@ Eg: IoTDB > FULL MERGE
505505
Eg: IoTDB > CLEAR CACHE
506506
```
507507

508+
- START REPAIR DATA
509+
510+
```sql
511+
Eg: IoTDB > START REPAIR DATA
512+
```
513+
514+
- STOP REPAIR DATA
515+
516+
```sql
517+
Eg: IoTDB > STOP REPAIR DATA
518+
```
519+
508520
- SET SYSTEM TO READONLY / WRITABLE
509521

510522
```

src/UserGuide/Master/Reference/Common-Config-Manual.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1129,6 +1129,15 @@ Different configuration parameters take effect in the following three ways:
11291129
|Default| 50 |
11301130
|Effective| After restart system |
11311131

1132+
* compaction\_schedule\_thread\_num
1133+
1134+
|Name| compaction\_schedule\_thread\_num |
1135+
|:---:|:--------------------------------------------------------------------------|
1136+
|Description| The number of threads to be set up to select compaction task. |
1137+
|Type| Int32 |
1138+
|Default| 4 |
1139+
|Effective| hot-load |
1140+
11321141
### Write Ahead Log Configuration
11331142

11341143
* wal\_mode

src/UserGuide/Master/SQL-Manual/SQL-Manual.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1735,6 +1735,18 @@ Eg: IoTDB > FULL MERGE
17351735
Eg: IoTDB > CLEAR CACHE
17361736
```
17371737

1738+
- START REPAIR DATA
1739+
1740+
```sql
1741+
Eg: IoTDB > START REPAIR DATA
1742+
```
1743+
1744+
- STOP REPAIR DATA
1745+
1746+
```sql
1747+
Eg: IoTDB > STOP REPAIR DATA
1748+
```
1749+
17381750
- SET SYSTEM TO READONLY / WRITABLE
17391751

17401752
```

src/UserGuide/Master/User-Manual/Maintennance.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,3 +347,26 @@ Observing the results, we found that it is because the query did not add a time
347347
The final optimization plan is: Add a time filtering condition to avoid a full table scan.
348348

349349

350+
## Start/Stop Repair Data Statements
351+
Used to repair the unsorted data generate by system bug.
352+
### START REPAIR DATA
353+
354+
Start a repair task to scan all files created before current time.
355+
The repair task will scan all tsfiles and repair some bad files.
356+
357+
```sql
358+
IoTDB> START REPAIR DATA
359+
IoTDB> START REPAIR DATA ON LOCAL
360+
IoTDB> START REPAIR DATA ON CLUSTER
361+
```
362+
363+
### STOP REPAIR DATA
364+
365+
Stop the running repair task. To restart the stopped task.
366+
If there is a stopped repair task, it can be restart and recover the repair progress by executing SQL `START REPAIR DATA`.
367+
368+
```sql
369+
IoTDB> STOP REPAIR DATA
370+
IoTDB> STOP REPAIR DATA ON LOCAL
371+
IoTDB> STOP REPAIR DATA ON CLUSTER
372+
```

src/UserGuide/Master/stage/Administration-Management/Administration.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,18 @@ Eg: IoTDB > FULL MERGE
501501
Eg: IoTDB > CLEAR CACHE
502502
```
503503

504+
- START REPAIR DATA
505+
506+
```sql
507+
Eg: IoTDB > START REPAIR DATA
508+
```
509+
510+
- STOP REPAIR DATA
511+
512+
```sql
513+
Eg: IoTDB > STOP REPAIR DATA
514+
```
515+
504516
- SET SYSTEM TO READONLY / WRITABLE
505517

506518
```

src/UserGuide/Master/stage/Maintenance-Tools/Maintenance-Command.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,27 @@ IoTDB> CLEAR CACHE ON LOCAL
4747
IoTDB> CLEAR CACHE ON CLUSTER
4848
```
4949

50+
## START REPAIR DATA
51+
52+
Start a repair task to scan all files created before current time.
53+
The repair task will scan all tsfiles and repair some bad files.
54+
55+
```sql
56+
IoTDB> START REPAIR DATA
57+
IoTDB> START REPAIR DATA ON LOCAL
58+
IoTDB> START REPAIR DATA ON CLUSTER
59+
```
60+
61+
## STOP REPAIR DATA
62+
63+
Stop the running repair task. To restart the stopped task.
64+
If there is a stopped repair task, it can be restart and recover the repair progress by executing SQL `START REPAIR DATA`.
65+
66+
```sql
67+
IoTDB> STOP REPAIR DATA
68+
IoTDB> STOP REPAIR DATA ON LOCAL
69+
IoTDB> STOP REPAIR DATA ON CLUSTER
70+
```
5071

5172
## SET SYSTEM TO READONLY / RUNNING
5273

src/UserGuide/latest/Deployment-and-Maintenance/Security-Management_apache.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,18 @@ Eg: IoTDB > FULL MERGE
497497
Eg: IoTDB > CLEAR CACHE
498498
```
499499

500+
- START REPAIR DATA
501+
502+
```sql
503+
Eg: IoTDB > START REPAIR DATA
504+
```
505+
506+
- STOP REPAIR DATA
507+
508+
```sql
509+
Eg: IoTDB > STOP REPAIR DATA
510+
```
511+
500512
- SET SYSTEM TO READONLY / WRITABLE
501513

502514
```

src/UserGuide/latest/Deployment-and-Maintenance/Security-Management_timecho.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,18 @@ Eg: IoTDB > FULL MERGE
505505
Eg: IoTDB > CLEAR CACHE
506506
```
507507

508+
- START REPAIR DATA
509+
510+
```sql
511+
Eg: IoTDB > START REPAIR DATA
512+
```
513+
514+
- STOP REPAIR DATA
515+
516+
```sql
517+
Eg: IoTDB > STOP REPAIR DATA
518+
```
519+
508520
- SET SYSTEM TO READONLY / WRITABLE
509521

510522
```

src/UserGuide/latest/Reference/Common-Config-Manual.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,6 +1036,15 @@ Different configuration parameters take effect in the following three ways:
10361036
|Default| 50 |
10371037
|Effective| After restart system |
10381038

1039+
* compaction\_schedule\_thread\_num
1040+
1041+
|Name| compaction\_schedule\_thread\_num |
1042+
|:---:|:--------------------------------------------------------------------------|
1043+
|Description| The number of threads to be set up to select compaction task. |
1044+
|Type| Int32 |
1045+
|Default| 4 |
1046+
|Effective| hot-load |
1047+
10391048
### Write Ahead Log Configuration
10401049

10411050
* wal\_mode

0 commit comments

Comments
 (0)