Revert "Revert "[v8.5.6] docs: update sync-diff-inspector docs for mo… #22674
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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, backup and restore tool BR, and data consistency checker sync-diff-inspector. | ||||||
|
|
||||||
| > **Tip:** | ||||||
| > | ||||||
| > - 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. | ||||||
|
Contributor
There was a problem hiding this comment. Simplify "v8.5.6 and later versions" to "v8.5.6 and later" for conciseness. Also, "without downloading" is more direct than "so there is no need to download".
Suggested change
References
|
||||||
| > - 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` <br/>`dm-master-{version}-linux-{arch}.tar.gz` <br/>`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 v8.5.6 and later versions: `tiflow-{version}-linux-{arch}.tar.gz` <br/>For TiDB versions before v8.5.6: `sync_diff_inspector` | | ||||||
|
Contributor
There was a problem hiding this comment. Concise phrasing is preferred. "v8.5.6 and later" is sufficient.
Suggested change
References
|
||||||
| | [PD Recover](/pd-recover.md) | `pd-recover-{version}-linux-{arch}.tar` | | ||||||
|
|
||||||
| > **Note:** | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -5,18 +5,9 @@ summary: Use sync-diff-inspector to compare data and repair inconsistent data. | |||||
|
|
||||||
| # sync-diff-inspector User Guide | ||||||
|
|
||||||
| [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. | ||||||
|
|
||||||
| ## Key features | ||||||
|
|
||||||
|
|
@@ -27,6 +18,36 @@ This guide introduces the key features of sync-diff-inspector and describes how | |||||
| * 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: | ||||||
|
|
||||||
| For TiDB v8.5.6 and later versions: | ||||||
|
Contributor
There was a problem hiding this comment. Simplify the version description for better readability.
Suggested change
References
|
||||||
|
|
||||||
| + 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). | ||||||
|
Contributor
There was a problem hiding this comment. The phrase "The sync-diff-inspector binary package" is repetitive since the list item already starts with "Binary package".
Suggested change
References
|
||||||
|
|
||||||
| + Docker image. Execute the following command to download: | ||||||
|
Contributor
There was a problem hiding this comment. Use a colon to introduce the instruction for better flow.
Suggested change
References
|
||||||
|
|
||||||
| ```shell | ||||||
| docker pull pingcap/sync-diff-inspector:latest | ||||||
| ``` | ||||||
|
|
||||||
| For TiDB versions before v8.5.6: | ||||||
|
Contributor
There was a problem hiding this comment. Simplify the version description.
Suggested change
References
|
||||||
|
|
||||||
| + 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). | ||||||
|
Contributor
There was a problem hiding this comment. Reduce repetition and clarify the source of the legacy package.
Suggested change
References
|
||||||
|
|
||||||
| + Docker image (legacy version). Execute the following command to download: | ||||||
|
Contributor
There was a problem hiding this comment. Use a colon to introduce the instruction.
Suggested change
References
|
||||||
|
|
||||||
| ```shell | ||||||
| docker pull pingcap/tidb-tools:latest | ||||||
| ``` | ||||||
|
|
||||||
| ## 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`. | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the style guide, we should avoid unnecessary words and repetition. Since this is the TiDB Toolkit, "TiDB tools" can be simplified to "tools". Also, consider a more concise format for the tool list.
References