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, and backup and restore tool BR.

Download - 图1

Tip

  • If your deployment environment has internet access, you can deploy a TiDB tool using a single TiUP command, 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.

Environment requirements

  • Operating system: Linux
  • Architecture: amd64 or arm64

You can download TiDB Toolkit from the following link:

  1. 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 v6.2.0 in the amd64 architecture is https://download.pingcap.org/tidb-community-toolkit-v6.2.0-linux-amd64.tar.gz.

Download - 图2

Note

If you need to download the PD Control tool pd-ctl, download the TiDB installation package separately from https://download.pingcap.org/tidb-community-server-{version}-linux-{arch}.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
TiDB Binlogpump-{version}-linux-{arch}.tar.gz
drainer-{version}-linux-{arch}.tar.gz
binlogctl
reparo
Backup & Restore (BR)br-{version}-linux-{arch}.tar.gz
sync-diff-inspectorsync_diff_inspector
TiSparktispark-{tispark-version}-any-any.tar.gz
spark-{spark-version}-any-any.tar.gz
PD Recoverpd-recover-{version}-linux-{arch}.tar

Download - 图3

Note

{version} depends on the version of the tool you are installing. {arch} depends on the architecture of the system, which can be amd64 or arm64.