README.md

BR

Backup & Restore (BR) is a command-line tool for distributed backup and restoration of the TiDB cluster data.

Architecture

Documentation

Chinese Document

English Document

Building

1. Install retool

2. To build binary and run test:

$ make
$ make test

Notice BR supports building with Go version Go >= 1.13

When BR is built successfully, you can find binary in the bin directory.

Installing and Deployment

TODO

Contributing

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

License

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