Skip to content
Rust Client for TiKV.
Branch: master
Clone or download
brson Merge pull request #33 from tikv/dont-clone-config
Don't copy Config internally. Take the value.
Latest commit 3ab4f95 Feb 26, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Merge branch 'master' into dont-clone-config Feb 25, 2019
src
tests Fix integration test. Feb 25, 2019
.gitignore Add gitignore Nov 13, 2018
.travis.yml
Cargo.toml Refine CI (#22) Feb 25, 2019
LICENSE
README.md Add README and some lib.rs docs (#31) Feb 15, 2019
rust-toolchain

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.
You can’t perform that action at this time.