Rust Client for TiKV

Brian Anderson 3ab4f9586a Merge pull request #33 from tikv/dont-clone-config 1 month ago
examples d6498832a9 Merge branch 'master' into dont-clone-config 1 month ago
src d6498832a9 Merge branch 'master' into dont-clone-config 1 month ago
tests 8941e2a84c Fix integration test. 1 month ago
.gitignore d8c604394f Add gitignore 5 months ago
.travis.yml 72f4a176a4 Refine CI (#22) 1 month ago
Cargo.toml 72f4a176a4 Refine CI (#22) 1 month ago
LICENSE db5d4ef3ca Initial commit 7 months ago
README.md a5a6b152cd Add README and some lib.rs docs (#31) 2 months ago
rust-toolchain ba8675409d The initial version of Raw KV implementation (#14) 3 months 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.

Install

There are no special requirements to use this. It is a Rust 2018 edition crate supporting stable and nightly.

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

[dependencies]
# ...Your other dependencies...
tikv-client = "~0.1"

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.