Skip to content

Commit da64d19

Browse files
authored
[v8.5.6] docs: update sync-diff-inspector docs for move to tiflow repo (#20001) (#21419)
1 parent 35cae78 commit da64d19

File tree

2 files changed

+31
-10
lines changed

2 files changed

+31
-10
lines changed

download-ecosystem-tools.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ summary: 本文介绍如何下载 TiDB 工具包。TiDB 工具包包含常用工
99

1010
## TiDB 工具包下载
1111

12-
TiDB 工具包中包含了一些常用的 TiDB 工具,例如数据导出工具 Dumpling、数据导入工具 TiDB Lightning、备份恢复工具 BR。
12+
TiDB 工具包中包含了一些常用的 TiDB 工具,例如数据导出工具 Dumpling、数据导入工具 TiDB Lightning、备份恢复工具 BR、数据一致性检查工具 sync-diff-inspector
1313

1414
> **建议:**
1515
>
16-
> 如果你的部署环境能访问互联网,无需单独下载 TiDB 工具包,可以直接通过使用 [TiUP 命令一键部署](/tiup/tiup-component-management.md)所需的 TiDB 工具。
16+
> 对于 TiDB v8.5.6 及以上版本,包括 sync-diff-inspector 在内的大多数工具都可以直接通过 TiUP 使用。如果你的部署环境能访问互联网,无需单独下载 TiDB 工具包,可以直接通过使用 [TiUP 命令一键部署](/tiup/tiup-component-management.md)所需的 TiDB 工具。
1717
1818
### 环境要求
1919

@@ -42,7 +42,7 @@ TiDB 工具包中包含了一些常用的 TiDB 工具,例如数据导出工具
4242
| [TiDB DM (Data Migration)](/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` |
4343
| [TiCDC](/ticdc/ticdc-overview.md) | `cdc-{version}-linux-{arch}.tar.gz` |
4444
| [Backup & Restore (BR)](/br/backup-and-restore-overview.md) | `br-{version}-linux-{arch}.tar.gz` |
45-
| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | `sync_diff_inspector` |
45+
| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | TiDB v8.5.6 及以上版本:`tiflow-{version}-linux-{arch}.tar.gz`<br/>TiDB v8.5.6 之前的版本:`sync_diff_inspector` |
4646
| [PD Recover](/pd-recover.md) | `pd-recover-{version}-linux-{arch}.tar.gz` |
4747

4848
> **注意:**

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

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ summary: sync-diff-inspector 是一个用于校验 MySQL/TiDB 中数据一致性
55

66
# sync-diff-inspector 用户文档
77

8-
[sync-diff-inspector](https://github.com/pingcap/tidb-tools/tree/master/sync_diff_inspector) 是一个用于校验 MySQL/TiDB 中两份数据是否一致的工具。该工具提供了修复数据的功能(适用于修复少量不一致的数据)。
8+
[sync-diff-inspector](https://github.com/pingcap/tiflow/tree/master/sync_diff_inspector) 是一个用于校验 MySQL/TiDB 中两份数据是否一致的工具。该工具提供了修复数据的功能(适用于修复少量不一致的数据)。
99

10-
主要功能:
10+
本文介绍 sync-diff-inspector 的主要功能,并说明如何配置以及使用该工具。
11+
12+
## 主要功能
1113

1214
* 对比表结构和数据
1315
* 如果数据不一致,则生成用于修复数据的 SQL 语句
@@ -16,12 +18,31 @@ summary: sync-diff-inspector 是一个用于校验 MySQL/TiDB 中数据一致性
1618
* 支持 [TiDB 主从集群的数据校验](/ticdc/ticdc-upstream-downstream-check.md)
1719
* 支持[从 TiDB DM 拉取配置的数据校验](/sync-diff-inspector/dm-diff.md)
1820

19-
你可通过以下方式下载 sync-diff-inspector:
21+
## 安装 sync-diff-inspector
22+
23+
sync-diff-inspector 的安装方法取决于 TiDB 版本。
24+
25+
对于 TiDB v8.5.6 及以上版本,你可通过以下方式下载 sync-diff-inspector:
26+
27+
+ 使用 TiUP 安装:
28+
29+
```shell
30+
tiup install sync-diff-inspector
31+
```
32+
33+
+ 下载 Binary 包。sync-diff-inspector 的安装包位于 TiDB 离线工具包中。下载方式,请参考 [TiDB 工具下载](/download-ecosystem-tools.md)。
34+
35+
+ 使用 Docker 镜像。执行以下命令进行下载:
36+
37+
```shell
38+
docker pull pingcap/sync-diff-inspector:latest
39+
```
40+
41+
对于 TiDB v8.5.6 之前版本,你可通过以下方式下载 sync-diff-inspector:
2042

21-
+ Binary 包。sync-diff-inspector 的安装包位于 TiDB 离线工具包中。下载方式,请参考 [TiDB 工具下载](/download-ecosystem-tools.md)
22-
+ Docker 镜像。执行以下命令进行下载:
43+
+ 下载来自 [`tidb-tools`](https://github.com/pingcap/tidb-tools) 仓库的 Binary 包。sync-diff-inspector 的安装包位于 TiDB 离线工具包中。下载方式,请参考 [TiDB 工具下载](/download-ecosystem-tools.md)。
2344

24-
{{< copyable "shell-regular" >}}
45+
+ 使用 Docker 镜像。执行以下命令进行下载:
2546

2647
```shell
2748
docker pull pingcap/tidb-tools:latest
@@ -279,7 +300,7 @@ Average Speed: 113.277149MB/s
279300
- 下游数据库冗余行,则是 DELETE 语句
280301
- 下游数据库行部分数据不一致,则是 REPLACE 语句,但会在 SQL 文件中通过注释的方法标明不同的列
281302
282-
```SQL
303+
```sql
283304
-- table: sbtest.sbtest99
284305
-- range in sequence: (3690708) < (id) <= (3720581)
285306
/*

0 commit comments

Comments
 (0)