tikv
/
client-rust
mirror of https://github.com/tikv/client-rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update readme: dependency, limit and code snippet 

Signed-off-by: ekexium <ekexium@gmail.com>
This commit is contained in:
ekexium 2020-09-21 15:51:10 +08:00
parent 298f2df6b4
commit 316a194002
1 changed files with 32 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -8,33 +8,56 @@
This crate provides a clean, ready to use client for [TiKV](https://github.com/tikv/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.
With this crate you can easily connect to any TiKV deployment, interact with it, and mutate the data it contains. It uses async/await internally and exposes some `async fn` APIs as well.
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
## Getting started
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`:
The TiKV client is a Rust library (crate). To use this crate in your project, add following dependencies in your `Cargo.toml`:
```toml
[dependencies]
# ...Your other dependencies...
tikv-client = { git = "https://github.com/tikv/client-rust.git" }
[patch.crates-io]
raft-proto = { git = "https://github.com/tikv/raft-rs", rev = "e624c1d48460940a40d8aa69b5329460d9af87dd" }
```
The client requires a Git dependency until we can [publish it](https://github.com/tikv/client-rust/issues/32).
There are [examples](examples) which show how to use the client in a Rust program.
The client provides two modes to interact with TiKV: raw and transactional.
In the current version (0.0.0), the transactional API only supports optimistic transactions.
Important note: It is **not recommended or supported** to use both the raw and transactional APIs on the same database.
Raw mode:
```rust
let config = Config::new(vec!["127.0.0.1:2379"]);
let client = RawClient::new(config).await?;
client.put("key".to_owned(), "value".to_owned()).await;
let value = client.get("key".to_owned()).await;
```
Transactional mode:
```rust
let config = Config::new(vec!["127.0.0.1:2379"]);
let txn_client = TransactionClient::new(config).await?;
let mut txn = txn_client.begin().await?;
txn.set("key".to_owned(), "value".to_owned()).await?;
let value = txn.get("key".to_owned()).await;
txn.commit().await?;
```
There are some [examples](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](https://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`.
```bash