Download 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.

Environment requirements

  • Operating system: Linux
  • Architecture: amd64 or arm64

You can download TiDB Toolkit from the following link:

https://download.pingcap.org/tidb-community-toolkit-{version}-linux-{arch}.tar.gz

{version} in the link indicates the version number of TiDB and {arch} indicates the architecture of the system, which can be amd64 or arm64. For example, the download link for v8.5.0 in the amd64 architecture is https://download.pingcap.org/tidb-community-toolkit-v8.5.0-linux-amd64.tar.gz.

TiDB Toolkit description

Depending on which tools you want to use, you can install the corresponding offline packages as follows:

ToolOffline package name
TiUPtiup-linux-{arch}.tar.gz
tiup-{tiup-version}-linux-{arch}.tar.gz
dm-{tiup-version}-linux-{arch}.tar.gz
server-{version}-linux-{arch}.tar.gz
Dumplingdumpling-{version}-linux-{arch}.tar.gz
TiDB Lightningtidb-lightning-ctl
tidb-lightning-{version}-linux-{arch}.tar.gz
TiDB Data Migration (DM)dm-worker-{version}-linux-{arch}.tar.gz
dm-master-{version}-linux-{arch}.tar.gz
dmctl-{version}-linux-{arch}.tar.gz
TiCDCcdc-{version}-linux-{arch}.tar.gz
Backup & Restore (BR)br-{version}-linux-{arch}.tar.gz
sync-diff-inspectorFor TiDB v9.0.0 and later versions: tiflow-{version}-linux-{arch}.tar.gz
For TiDB versions before v9.0.0: sync_diff_inspector
PD Recoverpd-recover-{version}-linux-{arch}.tar

Was this page helpful?