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

readme: update dependency and doc 

Signed-off-by: ekexium <ekexium@gmail.com>
This commit is contained in:
ekexium 2020-11-02 11:56:47 +08:00
parent fa434640cc
commit 23714d7ac9
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -20,15 +20,12 @@ The TiKV client is a Rust library (crate). To use this crate in your project, ad
```toml ```toml
[dependencies] [dependencies]
tikv-client = { git = "https://github.com/tikv/client-rust.git" } 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). The client requires a Git dependency until we can [publish it](https://github.com/tikv/client-rust/issues/32).
The client provides two modes to interact with TiKV: raw and transactional. 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. In the current version (0.0.0), the transactional API supports optimistic transactions. Pessimistic transactions are implemented but not well tested.
Important note: It is **not recommended or supported** to use both the raw and transactional APIs on the same database. Important note: It is **not recommended or supported** to use both the raw and transactional APIs on the same database.
@ -111,10 +108,11 @@ To use the client, there are 4 types you will need.
## Access the documentation ## Access the documentation
We recommend using the cargo-generated documentation to browse and understand the API. We've done We've done our best to include ample, tested, and understandable examples.
our best to include ample, tested, and understandable examples.
You can access the documentation on your machine by running the following in any project that depends on `tikv-client`. We recommend using the officially maintained documentation [here](https://www.tikv.dev/doc/rust-client/tikv_client/).
You can also access the documentation on your machine by running the following in any project that depends on `tikv-client`.
```bash ```bash
cargo doc --package tikv-client --open cargo doc --package tikv-client --open