github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/README_DM.md (about)

     1  # TiDB Data Migration Platform
     2  
     3  [**TiDB Data Migration (DM)**](https://docs.pingcap.com/tidb/stable/dm-overview) is an integrated data migration task management platform that supports full data migration and incremental data replication from MySQL or MariaDB to [TiDB](https://docs.pingcap.com/tidb/stable). It helps reduce the operations cost and simplify the troubleshooting process.
     4  
     5  ## Architecture
     6  
     7  ![architecture](dm/docs/media/dm-architecture.png)
     8  
     9  ## Documentation
    10  
    11  - [English](https://docs.pingcap.com/tidb/stable/dm-overview)
    12  - [简体中文](https://docs.pingcap.com/zh/tidb/stable/dm-overview)
    13  
    14  ## Build
    15  
    16  To check the code style and build binaries, you can simply run:
    17  
    18  ```bash
    19  make build
    20  ```
    21  
    22  Note that DM supports building with the Go version `Go >= 1.21`. For unit test preparation, see [Running/Unit Test](dm/tests/README.md#Unit-Test).
    23  
    24  If you only want to build binaries, you can run:
    25  
    26  ```bash
    27  make dm-worker  # build DM-worker
    28  
    29  make dm-master  # build DM-master
    30  
    31  make dmctl      # build dmctl
    32  ```
    33  
    34  After DM is built successfully, you can find binaries in the `bin` directory.
    35  
    36  ## Run tests
    37  
    38  Run all tests, including unit tests and integration tests:
    39  
    40  See [Tests README](dm/tests/README.md) for a more detailed guide.
    41  
    42  ```bash
    43  make test
    44  ```
    45  
    46  ## Install
    47  
    48  See [DM Quick Start Guide](https://docs.pingcap.com/tidb/stable/quick-start-with-dm) and [Deploy a DM Cluster Using TiUP](https://docs.pingcap.com/tidb/stable/deploy-a-dm-cluster-using-tiup).
    49  
    50  ## Configuration file
    51  
    52  See [DM Configuration File Overview](https://docs.pingcap.com/tidb/stable/dm-config-overview).
    53  
    54  ## Roadmap
    55  
    56  See [Roadmap](dm/roadmap.md).
    57  
    58  ## Contributing
    59  
    60  We welcome and greatly appreciate contributions. See [CONTRIBUTING.md](dm/CONTRIBUTING.md)
    61  for details on submitting patches and the contribution workflow.
    62  
    63  If you have any questions, let's discuss them on the [TiDB Internals forum](https://internals.tidb.io/).
    64  
    65  ## More resources
    66  
    67  - TiDB blog
    68  
    69    - [English](https://pingcap.com/blog/)
    70    - [简体中文](https://cn.pingcap.com/blog/)
    71  
    72  - TiDB case studies
    73  
    74    - [English](https://www.pingcap.com/customers/)
    75    - [简体中文](https://cn.pingcap.com/case/)