Skip to content

Commit 15d68d9

Browse files
authored
Revert "Revert "[v8.5.6] docs: update sync-diff-inspector docs for mo… (#22674)
1 parent 8b98381 commit 15d68d9

2 files changed

Lines changed: 35 additions & 14 deletions

File tree

download-ecosystem-tools.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ summary: Download the most officially maintained versions of TiDB tools.
77

88
This document describes how to download the TiDB Toolkit.
99

10-
TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpling, data import tool TiDB Lightning, and backup and restore tool BR.
10+
TiDB Toolkit contains frequently used tools, such as Dumpling (data export), TiDB Lightning (data import), BR (backup and restore), and sync-diff-inspector (data consistency check).
1111

1212
> **Tip:**
1313
>
14-
> - If your deployment environment has internet access, you can deploy a TiDB tool using a single [TiUP command](/tiup/tiup-component-management.md), so there is no need to download the TiDB Toolkit separately.
14+
> - For TiDB v8.5.6 and later, most tools, including sync-diff-inspector, are directly available through TiUP. If your deployment environment has internet access, you can deploy a tool using a single [TiUP command](/tiup/tiup-component-management.md) without downloading the TiDB Toolkit separately.
1515
> - If you need to deploy and maintain TiDB on Kubernetes, instead of downloading the TiDB Toolkit, follow the steps in [TiDB Operator offline installation](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tidb-operator#offline-installation).
1616
1717
## Environment requirements
@@ -45,7 +45,7 @@ Depending on which tools you want to use, you can install the corresponding offl
4545
| [TiDB Data Migration (DM)](/dm/dm-overview.md) | `dm-worker-{version}-linux-{arch}.tar.gz` <br/>`dm-master-{version}-linux-{arch}.tar.gz` <br/>`dmctl-{version}-linux-{arch}.tar.gz` |
4646
| [TiCDC](/ticdc/ticdc-overview.md) | `cdc-{version}-linux-{arch}.tar.gz` |
4747
| [Backup & Restore (BR)](/br/backup-and-restore-overview.md) | `br-{version}-linux-{arch}.tar.gz` |
48-
| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | `sync_diff_inspector` |
48+
| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v8.5.6 and later: `tiflow-{version}-linux-{arch}.tar.gz` <br/>For versions before v8.5.6: `sync_diff_inspector` |
4949
| [PD Recover](/pd-recover.md) | `pd-recover-{version}-linux-{arch}.tar` |
5050

5151
> **Note:**

sync-diff-inspector/sync-diff-inspector-overview.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,9 @@ summary: Use sync-diff-inspector to compare data and repair inconsistent data.
55

66
# sync-diff-inspector User Guide
77

8-
[sync-diff-inspector](https://github.com/pingcap/tidb-tools/tree/master/sync_diff_inspector) is a tool used to compare data stored in the databases with the MySQL protocol. For example, it can compare the data in MySQL with that in TiDB, the data in MySQL with that in MySQL, or the data in TiDB with that in TiDB. In addition, you can also use this tool to repair data in the scenario where a small amount of data is inconsistent.
8+
[sync-diff-inspector](https://github.com/pingcap/tiflow/tree/master/sync_diff_inspector) is a tool used to compare data stored in the databases with the MySQL protocol. For example, it can compare the data in MySQL with that in TiDB, the data in MySQL with that in MySQL, or the data in TiDB with that in TiDB. In addition, you can also use this tool to repair data in the scenario where a small amount of data is inconsistent.
99

10-
This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool. To download sync-diff-inspector, use one of the following methods:
11-
12-
+ Binary package. The sync-diff-inspector binary package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).
13-
+ Docker image. Execute the following command to download:
14-
15-
{{< copyable "shell-regular" >}}
16-
17-
```shell
18-
docker pull pingcap/tidb-tools:latest
19-
```
10+
This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool.
2011

2112
## Key features
2213

@@ -27,6 +18,36 @@ This guide introduces the key features of sync-diff-inspector and describes how
2718
* Support [data check for TiDB upstream-downstream clusters](/ticdc/ticdc-upstream-downstream-check.md)
2819
* Support [data check in the DM replication scenario](/sync-diff-inspector/dm-diff.md)
2920

21+
## Install sync-diff-inspector
22+
23+
The installation method varies depending on your TiDB version:
24+
25+
For TiDB v8.5.6 and later:
26+
27+
+ Install using TiUP:
28+
29+
```shell
30+
tiup install sync-diff-inspector
31+
```
32+
33+
+ Binary package: included in the TiDB Toolkit. To download the toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).
34+
35+
+ Docker image: execute the following command to download:
36+
37+
```shell
38+
docker pull pingcap/sync-diff-inspector:latest
39+
```
40+
41+
For versions before v8.5.6:
42+
43+
+ Binary package: included in the TiDB Toolkit (from the legacy [`tidb-tools`](https://github.com/pingcap/tidb-tools) repository). To download the toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).
44+
45+
+ Docker image (legacy version): execute the following command to download:
46+
47+
```shell
48+
docker pull pingcap/tidb-tools:latest
49+
```
50+
3051
## Restrictions of sync-diff-inspector
3152

3253
* Online check is not supported for data migration between MySQL and TiDB. Ensure that no data is written into the upstream-downstream checklist, and that data in a certain range is not changed. You can check data in this range by setting `range`.

0 commit comments

Comments
 (0)