TiDB Data Migration Platform

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

Architecture

Documentation

• Detailed documentation
• 简体中文文档

Building

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

make build

Note that DM supports building with Go version Go >= 1.16, and unit test preparation can be found in 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

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

Run tests

Run all tests, including unit tests and integration tests:

See test/README.md for a more detailed guidance.

make test

Installing

See the "Deploy" section in our doc

Config File

See the "Configuration" section in our doc

Roadmap

Read the Roadmap.

Contributing

Contributions are welcomed and greatly appreciated. See CONTRIBUTING.md for details on submitting patches and the contribution workflow.

Any questions? Let's discuss in #sig-migrate in Slack

License

DM is under the Apache 2.0 license. See the LICENSE file for details.

More resources

• TiDB blog

  • English
  • 简体中文

• TiDB case studies

  • English
  • 简体中文