tikv: A Rust repository from zhitaoli

TiKV is a distributed Key-Value database powered by Rust and Raft

TiKV (The pronunciation is: /'taɪkeɪvi:/ tai-K-V, etymology: titanium) is a distributed Key-Value database which is based on the design of Google Spanner and HBase, but it is much simpler without dependency on any distributed file system. With the implementation of the Raft consensus algorithm in Rust and consensus state stored in RocksDB, it guarantees data consistency. Placement Driver which is introduced to implement sharding enables automatic data migration. The transaction model is similar to Google's Percolator with some performance improvements. TiKV also provides snapshot isolation (SI), snapshot isolation with lock (SQL: SELECT ... FOR UPDATE), and externally consistent reads and writes in distributed transactions.

TiKV has the following primary features:

Geo-Replication: TiKV uses Raft and the Placement Driver to support Geo-Replication.
Horizontal scalability: With Placement Driver and carefully designed Raft groups, TiKV excels in horizontal scalability and can easily scale to 100+ TBs of data.
Consistent distributed transactions: Similar to Google's Spanner, TiKV supports externally-consistent distributed transactions.
Coprocessor support: Similar to Hbase, TiKV implements a coprocessor framework to support distributed computing.
Cooperates with TiDB: Thanks to the internal optimization, TiKV and TiDB can work together to be a compelling database solution with high horizontal scalability, externally-consistent transations, and support for RDMBS and NoSQL design patterns.

The TiKV Software Stack

Placement Driver: Placement Driver (PD) is the cluster manager of TiKV. PD periodically checks replication constraints to balance load and data automatically.
Store: There is a RocksDB within each Store and it stores data into local disk.
Region: Region is the basic unit of Key-Value data movement. Each Region is replicated to multiple Nodes. These multiple replicas form a Raft group.
Node: A physical node in the cluster. Within each node, there are one or more Stores. Within each Store, there are many Regions.

When a node starts, the metadata of the Node, Store and Region are registered into PD. The status of each Region and Store is reported to PD regularly.

Your First Test Drive

We have a Docker Compose you can use to test out TiKV and TiDB.

git clone https://github.com/pingcap/tidb-docker-compose/
cd tidb-docker-compose
docker-compose up -d

Shortly after you will be able to connect with mysql -h 127.0.0.1 -P 4000 -u root and view the cluster metrics at http://localhost:3000/.

Setting Up a Development Workspace

The TiKV codebase is primarily written in Rust, but has components written in C++ (RocksDB) and Go (gRPC). In order to provide consistency and avoid opinion-based arguments, we make extensive use of linters and automated formatting tools. Additionally, due to Rust's youth we are currently utlizing nightly builds which provide access to many useful features.

Checking Your Prerequisites

In order to build TiKV you will need (at least) the following packages available:

git - Version control
rustup - Rust toolchain manager
awk - Pattern scanning/processing language
cmake - Build tool (required for gRPC)
go - Programming language (required for gRPC)
make - Build tool (run common workflows)
clang or gcc - C compiler toolchain

Getting the Repository

git clone https://github.com/pingcap/tikv.git
cd tikv
# Future instructions assume you are in this repository

Configuring Your Rust Toolchain

rustup is an official toolchain manager for Rust, akin to rvm or rbenv from the Ruby world.

TiKV uses the version of the Rust toolchain specified in RUST_VERSION. We also make use of the rustfmt component.

rustup override set `tail -n 1 RUST_VERSION`
rustup component add rustfmt-preview --toolchain `tail -n 1 RUST_VERSION`

Building & Testing

While TiKV includes a Makefile with common workflows, you are also able to use cargo as you would a normal Rust project.

At this point you should be able to build TiKV:

make build

While interactively developing you may prefer using cargo check, which will do parse, borrow check, and lint run on your code, but not actually compile it. It is particularly handy alongside cargo-watch which will run a command each time you change a file.

cargo install cargo-watch
cargo watch -s "cargo check --features dev"

When you're ready to test out your changes you should use the dev task. It will format your codebase, build with clippy enabled, and run tests. This should run without fail before you make a PR.

make dev

You can run the full test suite locally, or just run a specific test:

# Run the full suite
make test
# Run a specific test
cargo test $TESTNAME

Any pull requests made will automatically be tested by our CI systems, so making sure the full suite passes before creating your PR is not strictly required. All merged PRs must have passing CI tests.

Getting the Rest of the System Working

In order to get other components (TiDB and PD working we suggest you follow the development guide as you will need to (at least) have pd-server working alongside tikv-server in order to do integration level testing.

Deploying To Production

Use Ansible? The official Ansible deployment guide outlines the recommended way of deploying a cluster of TiKV nodes alongside the other components of a cluster.

Prefer Docker? You can find a guide on deploying a cluster with Docker to run the TiKV and the rest of the cluster.

Want to roll your own? That works too! We have written a Binary deployment Guide which might help you as you piece together your own way of doing things.

Using TiKV

TiKV is a component in the TiDB project. To run TiKV you must build and run it with PD, which is used to manage the cluster.

Currently the only interface to TiKV is the TiDB Go client and the TiSpark Java client.

We would love it if you developed drivers in other languages.

Configuration

Read our configuration guide to learn about the various configuration options.

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

License

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

Acknowledgments

Thanks etcd for providing some great open source tools.
Thanks RocksDB for their powerful storage engines.
Thanks mio for providing metal IO library for Rust.
Thanks rust-clippy. We do love the great project.

zhitaoli/tikv