TiDB Data Migration Platform

October 9, 2024 · View on GitHub

TiDB Data Migration (DM) is an integrated data migration task management platform that supports full data migration and incremental data replication from MySQL or MariaDB to TiDB. It helps reduce the operations cost and simplify the troubleshooting process.

Architecture

architecture

Documentation

Build

To check the code style and build binaries, you can simply run:

make build

Note that DM supports building with the Go version Go >= 1.23. For unit test preparation, see Running/Unit Test.

If you only want to build binaries, you can run:

make dm-worker  # build DM-worker

make dm-master  # build DM-master

make dmctl      # build dmctl

After DM is built successfully, you can find binaries in the bin directory.

Run tests

Run all tests, including unit tests and integration tests:

See Tests README for a more detailed guide.

make test

Install

See DM Quick Start Guide and Deploy a DM Cluster Using TiUP.

Configuration file

See DM Configuration File Overview.

Roadmap

See Roadmap.

Contributing

We welcome and greatly appreciate contributions. See CONTRIBUTING.md for details on submitting patches and the contribution workflow.

If you have any questions, let's discuss them on the TiDB Internals forum.

More resources