From f660229377b7dc4d0d7049fd89e4e557251bd6f5 Mon Sep 17 00:00:00 2001 From: Airton Lastori Date: Thu, 23 Jan 2025 19:51:54 -0500 Subject: [PATCH 01/11] docs: update sync-diff-inspector docs for move to tiflow repo - Update GitHub repository links from tidb-tools to tiflow - Add TiUP installation method for v9.0.0+ - Update Docker image references - Add version-specific installation instructions - Update download-ecosystem-tools.md with new package information --- download-ecosystem-tools.md | 6 +++--- .../sync-diff-inspector-overview.md | 21 ++++++++++++++++--- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md index f1d4e44648420..ad860ea8e1af0 100644 --- a/download-ecosystem-tools.md +++ b/download-ecosystem-tools.md @@ -7,11 +7,11 @@ summary: Download the most officially maintained versions of TiDB tools. This document describes how to download the TiDB Toolkit. -TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpling, data import tool TiDB Lightning, and backup and restore tool BR. +TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpling, data import tool TiDB Lightning, backup and restore tool BR, and data consistency checker sync-diff-inspector. > **Tip:** > -> - 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. +> - For TiDB v9.0.0 and later, most tools including sync-diff-inspector are directly available through TiUP. 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. > - 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). ## Environment requirements @@ -45,7 +45,7 @@ Depending on which tools you want to use, you can install the corresponding offl | [TiDB Data Migration (DM)](/dm/dm-overview.md) | `dm-worker-{version}-linux-{arch}.tar.gz`
`dm-master-{version}-linux-{arch}.tar.gz`
`dmctl-{version}-linux-{arch}.tar.gz` | | [TiCDC](/ticdc/ticdc-overview.md) | `cdc-{version}-linux-{arch}.tar.gz` | | [Backup & Restore (BR)](/br/backup-and-restore-overview.md) | `br-{version}-linux-{arch}.tar.gz` | -| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | `sync_diff_inspector` | +| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v9.0.0 and later: included in TiUP and `tiflow-{version}-linux-{arch}.tar.gz`
For TiDB versions before v9.0.0: `sync_diff_inspector` from tidb-tools | | [PD Recover](/pd-recover.md) | `pd-recover-{version}-linux-{arch}.tar` | > **Note:** diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index c32174029ffb5..4f9295f3c1a33 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -5,15 +5,30 @@ summary: Use sync-diff-inspector to compare data and repair inconsistent data. # sync-diff-inspector User Guide -[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. +[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. -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: +This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool. The installation method varies depending on your TiDB version: +For TiDB v9.0.0 and later: ++ Install using TiUP: + ```shell + tiup install sync-diff-inspector + ``` + 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). + Docker image. Execute the following command to download: {{< copyable "shell-regular" >}} + ```shell + docker pull pingcap/tiflow:latest + ``` + +For TiDB versions before v9.0.0: ++ Binary package from the legacy tidb-tools repository. 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). ++ Docker image (legacy version). Execute the following command to download: + + {{< copyable "shell-regular" >}} + ```shell docker pull pingcap/tidb-tools:latest ``` @@ -105,7 +120,7 @@ skip-non-existing-table = false # (optional) Use the snapshot feature. If enabled, historical data is used for comparison. # snapshot = "386902609362944000" - # When "snapshot" is set to "auto", the last syncpoints generated by TiCDC in the upstream and downstream are used for comparison. For details, see . + # When "snapshot" is set to "auto", the last syncpoints generated by TiCDC in the upstream and downstream are used for comparison. For details, see . # snapshot = "auto" ########################### Routes ############################## From 52596cd4f2e0e2da53f70e1ac75a7b28f54886ed Mon Sep 17 00:00:00 2001 From: Airton Lastori Date: Thu, 23 Jan 2025 20:18:34 -0500 Subject: [PATCH 02/11] style: fix markdown linting errors in sync-diff-inspector docs --- sync-diff-inspector/sync-diff-inspector-overview.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index 4f9295f3c1a33..d1fc76b8f9e59 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -10,11 +10,15 @@ summary: Use sync-diff-inspector to compare data and repair inconsistent data. This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool. The installation method varies depending on your TiDB version: For TiDB v9.0.0 and later: + + Install using TiUP: + ```shell tiup install sync-diff-inspector ``` + + 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). + + Docker image. Execute the following command to download: {{< copyable "shell-regular" >}} @@ -24,7 +28,9 @@ For TiDB v9.0.0 and later: ``` For TiDB versions before v9.0.0: + + Binary package from the legacy tidb-tools repository. 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). + + Docker image (legacy version). Execute the following command to download: {{< copyable "shell-regular" >}} @@ -297,8 +303,6 @@ A SQL file contains the tale to which the chunk belong and the range information DIFF COLUMNS ╏ `K` ╏ `C` ╏ `PAD` ╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍ source data ╏ 2501808 ╏ 'hello' ╏ 'world' -╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍ - target data ╏ 5003616 ╏ '0709824117-9809973320-4456050422' ╏ '1714066100-7057807621-1425865505' ╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍ */ REPLACE INTO `sbtest`.`sbtest99`(`id`,`k`,`c`,`pad`) VALUES (3700000,2501808,'hello','world'); From 3bd4d9c9c179df6dc88f4da2465116d5061a559e Mon Sep 17 00:00:00 2001 From: Airton Lastori Date: Tue, 28 Jan 2025 12:28:06 -0500 Subject: [PATCH 03/11] Update sync-diff-inspector-overview.md Update Docker image for sync-diff-inspector The previous `docker pull pingcap/tiflow:latest` command was incorrect. After confirming with Flare Zuo (R&D Group - Engineering Productivity - Efficiency & Ops team), we should use `docker pull pingcap/sync-diff-inspector:latest` to align with TiCDC and DM, ensuring consistency across TiFlow-managed images. This update reflects the correct image name for better usability. --- sync-diff-inspector/sync-diff-inspector-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index d1fc76b8f9e59..aded57dc68a78 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -24,7 +24,7 @@ For TiDB v9.0.0 and later: {{< copyable "shell-regular" >}} ```shell - docker pull pingcap/tiflow:latest + docker pull pingcap/sync-diff-inspector:latest ``` For TiDB versions before v9.0.0: From 423bbdce92f026d6e118c2163e8097ea3ba4b363 Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 26 Feb 2025 16:18:52 +0800 Subject: [PATCH 04/11] revise wording and remove copyable --- download-ecosystem-tools.md | 4 ++-- sync-diff-inspector/sync-diff-inspector-overview.md | 6 +----- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md index ad860ea8e1af0..db05353079b80 100644 --- a/download-ecosystem-tools.md +++ b/download-ecosystem-tools.md @@ -11,7 +11,7 @@ TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpl > **Tip:** > -> - For TiDB v9.0.0 and later, most tools including sync-diff-inspector are directly available through TiUP. 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. +> - For TiDB v9.0.0 and later versions, most tools, including sync-diff-inspector, are directly available through TiUP. 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. > - 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). ## Environment requirements @@ -45,7 +45,7 @@ Depending on which tools you want to use, you can install the corresponding offl | [TiDB Data Migration (DM)](/dm/dm-overview.md) | `dm-worker-{version}-linux-{arch}.tar.gz`
`dm-master-{version}-linux-{arch}.tar.gz`
`dmctl-{version}-linux-{arch}.tar.gz` | | [TiCDC](/ticdc/ticdc-overview.md) | `cdc-{version}-linux-{arch}.tar.gz` | | [Backup & Restore (BR)](/br/backup-and-restore-overview.md) | `br-{version}-linux-{arch}.tar.gz` | -| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v9.0.0 and later: included in TiUP and `tiflow-{version}-linux-{arch}.tar.gz`
For TiDB versions before v9.0.0: `sync_diff_inspector` from tidb-tools | +| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v9.0.0 and later versions: included in TiUP and `tiflow-{version}-linux-{arch}.tar.gz`
For TiDB versions before v9.0.0: `sync_diff_inspector` from tidb-tools | | [PD Recover](/pd-recover.md) | `pd-recover-{version}-linux-{arch}.tar` | > **Note:** diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index aded57dc68a78..e44ea4f372fd3 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -9,7 +9,7 @@ summary: Use sync-diff-inspector to compare data and repair inconsistent data. This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool. The installation method varies depending on your TiDB version: -For TiDB v9.0.0 and later: +For TiDB v9.0.0 and later versions: + Install using TiUP: @@ -21,8 +21,6 @@ For TiDB v9.0.0 and later: + Docker image. Execute the following command to download: - {{< copyable "shell-regular" >}} - ```shell docker pull pingcap/sync-diff-inspector:latest ``` @@ -33,8 +31,6 @@ For TiDB versions before v9.0.0: + Docker image (legacy version). Execute the following command to download: - {{< copyable "shell-regular" >}} - ```shell docker pull pingcap/tidb-tools:latest ``` From 06a32c6c74c2584a52f4a03856008ffa2c51c22f Mon Sep 17 00:00:00 2001 From: Aolin Date: Thu, 6 Mar 2025 15:29:52 +0800 Subject: [PATCH 05/11] add GitHub link --- sync-diff-inspector/sync-diff-inspector-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index e44ea4f372fd3..5781114f8ef83 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -27,7 +27,7 @@ For TiDB v9.0.0 and later versions: For TiDB versions before v9.0.0: -+ Binary package from the legacy tidb-tools repository. 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). ++ Binary package from the legacy [`tidb-tools`](https://github.com/pingcap/tidb-tools) repository. 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). + Docker image (legacy version). Execute the following command to download: From f5661c016ebf6ab6dced2b461b5b43c8d74d3397 Mon Sep 17 00:00:00 2001 From: Airton Lastori Date: Fri, 7 Mar 2025 19:52:39 -0500 Subject: [PATCH 06/11] Update download-ecosystem-tools.md Co-authored-by: Grace Cai --- download-ecosystem-tools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md index db05353079b80..e71f6661d0f6f 100644 --- a/download-ecosystem-tools.md +++ b/download-ecosystem-tools.md @@ -45,7 +45,7 @@ Depending on which tools you want to use, you can install the corresponding offl | [TiDB Data Migration (DM)](/dm/dm-overview.md) | `dm-worker-{version}-linux-{arch}.tar.gz`
`dm-master-{version}-linux-{arch}.tar.gz`
`dmctl-{version}-linux-{arch}.tar.gz` | | [TiCDC](/ticdc/ticdc-overview.md) | `cdc-{version}-linux-{arch}.tar.gz` | | [Backup & Restore (BR)](/br/backup-and-restore-overview.md) | `br-{version}-linux-{arch}.tar.gz` | -| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v9.0.0 and later versions: included in TiUP and `tiflow-{version}-linux-{arch}.tar.gz`
For TiDB versions before v9.0.0: `sync_diff_inspector` from tidb-tools | +| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v9.0.0 and later versions: `tiflow-{version}-linux-{arch}.tar.gz`
For TiDB versions before v9.0.0: `sync_diff_inspector` | | [PD Recover](/pd-recover.md) | `pd-recover-{version}-linux-{arch}.tar` | > **Note:** From 27c81b91df4469461376e44e5da89dbede9f1818 Mon Sep 17 00:00:00 2001 From: Airton Lastori Date: Mon, 17 Mar 2025 12:55:37 -0400 Subject: [PATCH 07/11] Update sync-diff-inspector/sync-diff-inspector-overview.md Co-authored-by: Grace Cai --- sync-diff-inspector/sync-diff-inspector-overview.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index 5781114f8ef83..fef4a92121087 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -7,7 +7,11 @@ summary: Use sync-diff-inspector to compare data and repair inconsistent data. [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. -This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool. The installation method varies depending on your TiDB version: +This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool. + +## Install sync-diff-inspector + +The installation method varies depending on your TiDB version: For TiDB v9.0.0 and later versions: From 9360d5db7ef84d68db21f6987cf7fddbe442311b Mon Sep 17 00:00:00 2001 From: Airton Lastori Date: Mon, 17 Mar 2025 13:02:47 -0400 Subject: [PATCH 08/11] Move Key features section before Install section to match introduction flow --- .../sync-diff-inspector-overview.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index fef4a92121087..2d1b52a559f39 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -9,6 +9,15 @@ summary: Use sync-diff-inspector to compare data and repair inconsistent data. This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool. +## Key features + +* Compare the table schema and data +* Generate the SQL statements used to repair data if the data inconsistency exists +* Support [data check for tables with different schema or table names](/sync-diff-inspector/route-diff.md) +* Support [data check in the sharding scenario](/sync-diff-inspector/shard-diff.md) +* Support [data check for TiDB upstream-downstream clusters](/ticdc/ticdc-upstream-downstream-check.md) +* Support [data check in the DM replication scenario](/sync-diff-inspector/dm-diff.md) + ## Install sync-diff-inspector The installation method varies depending on your TiDB version: @@ -39,15 +48,6 @@ For TiDB versions before v9.0.0: docker pull pingcap/tidb-tools:latest ``` -## Key features - -* Compare the table schema and data -* Generate the SQL statements used to repair data if the data inconsistency exists -* Support [data check for tables with different schema or table names](/sync-diff-inspector/route-diff.md) -* Support [data check in the sharding scenario](/sync-diff-inspector/shard-diff.md) -* Support [data check for TiDB upstream-downstream clusters](/ticdc/ticdc-upstream-downstream-check.md) -* Support [data check in the DM replication scenario](/sync-diff-inspector/dm-diff.md) - ## Restrictions of sync-diff-inspector * 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`. From 9e5cd09268cd428ee78dd9368dd9290c6449f16d Mon Sep 17 00:00:00 2001 From: Airton Lastori Date: Wed, 26 Mar 2025 13:08:11 -0400 Subject: [PATCH 09/11] Update sync-diff-inspector/sync-diff-inspector-overview.md Co-authored-by: Aolin --- sync-diff-inspector/sync-diff-inspector-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index 2d1b52a559f39..a7bed516cf003 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -126,7 +126,7 @@ skip-non-existing-table = false # (optional) Use the snapshot feature. If enabled, historical data is used for comparison. # snapshot = "386902609362944000" - # When "snapshot" is set to "auto", the last syncpoints generated by TiCDC in the upstream and downstream are used for comparison. For details, see . + # When "snapshot" is set to "auto", the last syncpoints generated by TiCDC in the upstream and downstream are used for comparison. For details, see . # snapshot = "auto" ########################### Routes ############################## From 8700f0cb93537fa350fa1d221564ce7a78cb6545 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Fri, 6 Mar 2026 12:12:28 +0800 Subject: [PATCH 10/11] Apply suggestions from code review --- download-ecosystem-tools.md | 4 ++-- sync-diff-inspector/sync-diff-inspector-overview.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md index e71f6661d0f6f..4051e6a8b81de 100644 --- a/download-ecosystem-tools.md +++ b/download-ecosystem-tools.md @@ -11,7 +11,7 @@ TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpl > **Tip:** > -> - For TiDB v9.0.0 and later versions, most tools, including sync-diff-inspector, are directly available through TiUP. 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. +> - For TiDB v8.5.6 and later versions, most tools, including sync-diff-inspector, are directly available through TiUP. 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. > - 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). ## Environment requirements @@ -45,7 +45,7 @@ Depending on which tools you want to use, you can install the corresponding offl | [TiDB Data Migration (DM)](/dm/dm-overview.md) | `dm-worker-{version}-linux-{arch}.tar.gz`
`dm-master-{version}-linux-{arch}.tar.gz`
`dmctl-{version}-linux-{arch}.tar.gz` | | [TiCDC](/ticdc/ticdc-overview.md) | `cdc-{version}-linux-{arch}.tar.gz` | | [Backup & Restore (BR)](/br/backup-and-restore-overview.md) | `br-{version}-linux-{arch}.tar.gz` | -| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v9.0.0 and later versions: `tiflow-{version}-linux-{arch}.tar.gz`
For TiDB versions before v9.0.0: `sync_diff_inspector` | +| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v8.5.6 and later versions: `tiflow-{version}-linux-{arch}.tar.gz`
For TiDB versions before v8.5.6: `sync_diff_inspector` | | [PD Recover](/pd-recover.md) | `pd-recover-{version}-linux-{arch}.tar` | > **Note:** diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index a7bed516cf003..754ce91ea1225 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -22,7 +22,7 @@ This guide introduces the key features of sync-diff-inspector and describes how The installation method varies depending on your TiDB version: -For TiDB v9.0.0 and later versions: +For TiDB v8.5.6 and later versions: + Install using TiUP: @@ -38,7 +38,7 @@ For TiDB v9.0.0 and later versions: docker pull pingcap/sync-diff-inspector:latest ``` -For TiDB versions before v9.0.0: +For TiDB versions before v8.5.6: + Binary package from the legacy [`tidb-tools`](https://github.com/pingcap/tidb-tools) repository. 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). From 01750cb943661c577401bb093c4c42189961284a Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Fri, 6 Mar 2026 13:35:32 +0800 Subject: [PATCH 11/11] Update sync-diff-inspector/sync-diff-inspector-overview.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- sync-diff-inspector/sync-diff-inspector-overview.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/sync-diff-inspector/sync-diff-inspector-overview.md b/sync-diff-inspector/sync-diff-inspector-overview.md index 754ce91ea1225..95a04c1698fa2 100644 --- a/sync-diff-inspector/sync-diff-inspector-overview.md +++ b/sync-diff-inspector/sync-diff-inspector-overview.md @@ -303,6 +303,8 @@ A SQL file contains the tale to which the chunk belong and the range information DIFF COLUMNS ╏ `K` ╏ `C` ╏ `PAD` ╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍ source data ╏ 2501808 ╏ 'hello' ╏ 'world' +╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍ + target data ╏ 5003616 ╏ '0709824117-9809973320-4456050422' ╏ '1714066100-7057807621-1425865505' ╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍ */ REPLACE INTO `sbtest`.`sbtest99`(`id`,`k`,`c`,`pad`) VALUES (3700000,2501808,'hello','world');