Skip to content

Commit 5a93379

Browse files
author
github-actions
committed
update MD by dispatch event pingcap/docs release-8.5
1 parent 83028cf commit 5a93379

File tree

4 files changed

+35
-45
lines changed

4 files changed

+35
-45
lines changed

markdown-pages/en/tidb/release-8.5/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 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.
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 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.
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 versions: `tiflow-{version}-linux-{arch}.tar.gz` <br/>For TiDB versions before v8.5.6: `sync_diff_inspector` |
4949
| [PD Recover](/pd-recover.md) | `pd-recover-{version}-linux-{arch}.tar` |
5050

5151
> **Note:**

markdown-pages/en/tidb/release-8.5/sync-diff-inspector/sync-diff-inspector-overview.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +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-
16-
```shell
17-
docker pull pingcap/tidb-tools:latest
18-
```
10+
This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool.
1911

2012
## Key features
2113

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

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 versions:
26+
27+
+ Install using TiUP:
28+
29+
```shell
30+
tiup install sync-diff-inspector
31+
```
32+
33+
+ 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).
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 TiDB versions before v8.5.6:
42+
43+
+ 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).
44+
45+
+ Docker image (legacy version). Execute the following command to download:
46+
47+
```shell
48+
docker pull pingcap/tidb-tools:latest
49+
```
50+
2951
## Restrictions of sync-diff-inspector
3052

3153
* 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`.

markdown-pages/en/tidb/release-8.5/system-variables.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3887,22 +3887,6 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified
38873887
- Range: `[100, 16384]`
38883888
- This variable is used to set the maximum number of schema versions (the table IDs modified for corresponding versions) allowed to be cached. The value range is 100 ~ 16384.
38893889

3890-
### tidb_max_dist_task_nodes <span class="version-mark">New in v8.5.6</span>
3891-
3892-
- Scope: SESSION | GLOBAL
3893-
- Persists to cluster: Yes
3894-
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No
3895-
- Type: Integer
3896-
- Default value: `-1`
3897-
- Range: `-1` or `[1, 128]`
3898-
- This variable defines the maximum number of TiDB nodes that the Distributed eXecution Framework (DXF) tasks can use. The default value is `-1`, which indicates that automatic mode is enabled. In automatic mode, TiDB dynamically calculates the value as `min(3, tikv_nodes / 3)`, where `tikv_nodes` represents the number of TiKV nodes in the cluster.
3899-
3900-
> **Note:**
3901-
>
3902-
> If you explicitly set the [`tidb_service_scope`](#tidb_service_scope-new-in-v740) system variable for some TiDB nodes, the Distributed eXecution Framework schedules tasks only to these nodes. In this case, even if you set `tidb_max_dist_task_nodes` to a larger value, the framework uses no more than the number of nodes explicitly configured with `tidb_service_scope`.
3903-
>
3904-
> For example, if the cluster has 10 TiDB nodes, and 4 of them are configured with `tidb_service_scope = group1`, then even if you set `tidb_max_dist_task_nodes = 5`, only 4 nodes participate in task execution.
3905-
39063890
### tidb_max_paging_size <span class="version-mark">New in v6.3.0</span>
39073891

39083892
- Scope: SESSION | GLOBAL

markdown-pages/en/tidbcloud/master/system-variables.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3887,22 +3887,6 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified
38873887
- Range: `[100, 16384]`
38883888
- This variable is used to set the maximum number of schema versions (the table IDs modified for corresponding versions) allowed to be cached. The value range is 100 ~ 16384.
38893889

3890-
### tidb_max_dist_task_nodes <span class="version-mark">New in v8.5.6</span>
3891-
3892-
- Scope: SESSION | GLOBAL
3893-
- Persists to cluster: Yes
3894-
- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No
3895-
- Type: Integer
3896-
- Default value: `-1`
3897-
- Range: `-1` or `[1, 128]`
3898-
- This variable defines the maximum number of TiDB nodes that the Distributed eXecution Framework (DXF) tasks can use. The default value is `-1`, which indicates that automatic mode is enabled. In automatic mode, TiDB dynamically calculates the value as `min(3, tikv_nodes / 3)`, where `tikv_nodes` represents the number of TiKV nodes in the cluster.
3899-
3900-
> **Note:**
3901-
>
3902-
> If you explicitly set the [`tidb_service_scope`](#tidb_service_scope-new-in-v740) system variable for some TiDB nodes, the Distributed eXecution Framework schedules tasks only to these nodes. In this case, even if you set `tidb_max_dist_task_nodes` to a larger value, the framework uses no more than the number of nodes explicitly configured with `tidb_service_scope`.
3903-
>
3904-
> For example, if the cluster has 10 TiDB nodes, and 4 of them are configured with `tidb_service_scope = group1`, then even if you set `tidb_max_dist_task_nodes = 5`, only 4 nodes participate in task execution.
3905-
39063890
### tidb_max_paging_size <span class="version-mark">New in v6.3.0</span>
39073891

39083892
- Scope: SESSION | GLOBAL

0 commit comments

Comments
 (0)