Rust Client for TiKV

Nick Cameron 9d9dca4103 Merge pull request #158 from nrc/refactor 1 week ago
examples 1868118ea6 set Value type to an alias of Vec<u8> 3 weeks ago
src 92a1649e48 Tidy up 1 week ago
tests d7bded1fbf Extract low-level store and pd crates. (#157) 2 weeks ago
tikv-client-common 92a1649e48 Tidy up 1 week ago
tikv-client-pd 92a1649e48 Tidy up 1 week ago
tikv-client-store d110ad1ecb Move region and store from common to store crate 1 week ago
.gitignore d7bded1fbf Extract low-level store and pd crates. (#157) 2 weeks ago
.travis.yml d8016e3594 Fixes to only install and run `rustfmt` and `clippy` on Rust stable. 4 months ago
Cargo.lock bc9ae7103e Refactor pd clients 1 week ago
Cargo.toml 100ae95a21 Update dependencies 1 week ago
LICENSE db5d4ef3ca Initial commit 1 year ago
README.md fe09429318 fix clippy 4 months ago
rustfmt.toml d7bded1fbf Extract low-level store and pd crates. (#157) 2 weeks ago

README.md

TiKV Client (Rust)

Build Status Documentation

Currently this crate is experimental and some portions (e.g. the Transactional API) are still in active development. You're encouraged to use this library for testing and to help us find problems!

This crate provides a clean, ready to use client for TiKV, a distributed transactional Key-Value database written in Rust.

With this crate you can easily connect to any TiKV deployment, interact with it, and mutate the data it contains.

This is an open source (Apache 2) project hosted by the Cloud Native Computing Foundation (CNCF) and maintained by the TiKV Authors. We'd love it if you joined us in improving this project.

Using the client

The TiKV client is a Rust library (crate). It uses async/await internally and exposes some async fn APIs as well.

To use this crate in your project, add it as a dependency in your Cargo.toml:

[dependencies]
# ...Your other dependencies...
tikv-client = { git = "https://github.com/tikv/client-rust.git" }

The client requires a Git dependency until we can publish it.

There are examples which show how to use the client in a Rust program.

Access the documentation

We recommend using the cargo-generated documentation to browse and understand the API. We've done our best to include ample, tested, and understandable examples.

You can visit docs.rs/tikv-client, or build the documentation yourself.

You can access the documentation on your machine by running the following in any project that depends on tikv-client.

cargo doc --package tikv-client --open
# If it didn't work, browse file URL it tried to open with your browser.

Minimal Rust Version

This crate supports Rust 1.40 and above.

For development, a nightly Rust compiler is needed to compile the tests.