br

README

TiKV-BR

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

Architecture

Building

To build binary and run test:

$ make build   // build the binary with debug info
$ make release // build the release binary used for production
$ make test    // run unit test

Notice TiKV-BR requires building with Go version Go >= 1.21

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

User Manual

For details, see TiKV-BR User Docs.

Contributing

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

License

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