Skip to content

Commit 9ae3e4f

Browse files
XuanwoXuanwo
authored
docs: Cmake and gcc is not needed anymore (#403)
* docs: Cmake and gcc is not needed anymore Signed-off-by: Xuanwo <github@xuanwo.io> * Update links Signed-off-by: Xuanwo <github@xuanwo.io> --------- Signed-off-by: Xuanwo <github@xuanwo.io>
1 parent 797960e commit 9ae3e4f

File tree

1 file changed

+31
-32
lines changed

1 file changed

+31
-32
lines changed

‎README.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# TiKV Client (Rust)
22

3-
[![Docs](https://docs.rs/tikv-client/badge.svg)](https://docs.rs/tikv-client)
4-
[![Build Status](https://travis-ci.org/tikv/client-rust.svg?branch=master)](https://travis-ci.org/tikv/client-rust)
3+
[![Docs](https://img.shields.io/docsrs/tikv-client/latest)](https://docs.rs/tikv-client)
4+
[![Build Status](https://img.shields.io/github/actions/workflow/status/tikv/client-rust/ci.yml)](https://github.com/tikv/client-rust/actions/workflows/ci.yml)
55

66
This crate provides an easy-to-use client for [TiKV](https://github.com/tikv/tikv), a distributed, transactional key-value database written in Rust.
77

@@ -21,8 +21,7 @@ tikv-client = "0.2.0"
2121
```
2222

2323
### Prerequisites
24-
- [`cmake`](https://cmake.org/) >= `3.12.0`, required for [`building gRPC in parallel`](https://cmake.org/cmake/help/latest/envvar/CMAKE_BUILD_PARALLEL_LEVEL.html)
25-
- [`gcc`](https://gcc.gnu.org/) >= `6.3.0`, required for [`building gRPC`](https://github.com/grpc/grpc/tree/master/src/cpp)
24+
2625
- [`rust`](https://www.rust-lang.org/) >= `1.56.1`, required for `hashbrown-v0.12.1`
2726

2827
The general flow of using the client crate is to create either a raw or transaction client object (which can be configured) then send commands using the client object, or use it to create transactions objects. In the latter case, the transaction is built up using various commands and then committed (or rolled back).
@@ -77,36 +76,36 @@ Important note: It is **not recommended or supported** to use both the raw and t
7776

7877
### Raw requests
7978

80-
| Request | Main parameter type | Result type | Noteworthy Behavior |
81-
| ------------------ | ------------------- | ---------------- | ---------------------------------------------- |
82-
| `put` | `KvPair` | | |
83-
| `get` | `Key` | `Option<Value>` | |
84-
| `delete` | `Key` | | |
85-
| `delete_range` | `BoundRange` | | |
86-
| `scan` | `BoundRange` | `Vec<KvPair>` | |
87-
| `batch_put` | `Iter<KvPair>` | | |
88-
| `batch_get` | `Iter<Key>` | `Vec<KvPair>` | Skips non-existent keys; does not retain order |
89-
| `batch_delete` | `Iter<Key>` | | |
90-
| `batch_scan` | `Iter<BoundRange>` | `Vec<KvPair>` | See docs for `each_limit` parameter behavior. The order of ranges is retained. |
91-
| `batch_scan_keys` | `Iter<BoundRange>` | `Vec<Key>` | See docs for `each_limit` parameter behavior. The order of ranges is retained. |
92-
| `compare_and_swap` | `Key` + 2x `Value` | `(Option<Value>, bool)` | |
79+
| Request | Main parameter type | Result type | Noteworthy Behavior |
80+
|--------------------|---------------------|-------------------------|--------------------------------------------------------------------------------|
81+
| `put` | `KvPair` | | |
82+
| `get` | `Key` | `Option<Value>` | |
83+
| `delete` | `Key` | | |
84+
| `delete_range` | `BoundRange` | | |
85+
| `scan` | `BoundRange` | `Vec<KvPair>` | |
86+
| `batch_put` | `Iter<KvPair>` | | |
87+
| `batch_get` | `Iter<Key>` | `Vec<KvPair>` | Skips non-existent keys; does not retain order |
88+
| `batch_delete` | `Iter<Key>` | | |
89+
| `batch_scan` | `Iter<BoundRange>` | `Vec<KvPair>` | See docs for `each_limit` parameter behavior. The order of ranges is retained. |
90+
| `batch_scan_keys` | `Iter<BoundRange>` | `Vec<Key>` | See docs for `each_limit` parameter behavior. The order of ranges is retained. |
91+
| `compare_and_swap` | `Key` + 2x `Value` | `(Option<Value>, bool)` | |
9392

9493
### Transactional requests
9594

96-
| Request | Main parameter type | Result type | Noteworthy Behavior |
97-
| ---------------------- | ------------------- | --------------- | ------------------------------------------------------------------ |
98-
| `put` | `KvPair` | | |
99-
| `get` | `Key` | `Option<value>` | |
100-
| `get_for_update` | `Key` | `Option<value>` | |
101-
| `key_exists` | `Key` | `bool` | |
102-
| `delete` | `Key` | | |
103-
| `scan` | `BoundRange` | `Iter<KvPair>` | |
104-
| `scan_keys` | `BoundRange` | `Iter<Key>` | |
105-
| `batch_get` | `Iter<Key>` | `Iter<KvPair>` | Skips non-existent keys; does not retain order |
106-
| `batch_get_for_update` | `Iter<Key>` | `Iter<KvPair>` | Skips non-existent keys; does not retain order |
107-
| `lock_keys` | `Iter<Key>` | | |
108-
| `send_heart_beat` | | `u64` (TTL) | |
109-
| `gc` | `Timestamp` | `bool` | Returns true if the latest safepoint in PD equals the parameter |
95+
| Request | Main parameter type | Result type | Noteworthy Behavior |
96+
|------------------------|---------------------|-----------------|-----------------------------------------------------------------|
97+
| `put` | `KvPair` | | |
98+
| `get` | `Key` | `Option<value>` | |
99+
| `get_for_update` | `Key` | `Option<value>` | |
100+
| `key_exists` | `Key` | `bool` | |
101+
| `delete` | `Key` | | |
102+
| `scan` | `BoundRange` | `Iter<KvPair>` | |
103+
| `scan_keys` | `BoundRange` | `Iter<Key>` | |
104+
| `batch_get` | `Iter<Key>` | `Iter<KvPair>` | Skips non-existent keys; does not retain order |
105+
| `batch_get_for_update` | `Iter<Key>` | `Iter<KvPair>` | Skips non-existent keys; does not retain order |
106+
| `lock_keys` | `Iter<Key>` | | |
107+
| `send_heart_beat` | | `u64` (TTL) | |
108+
| `gc` | `Timestamp` | `bool` | Returns true if the latest safepoint in PD equals the parameter |
110109

111110
# Development and contributing
112111

@@ -138,7 +137,7 @@ Please follow PingCAP's [Rust style guide](https://pingcap.github.io/style-guid
138137

139138
## Getting help
140139

141-
If you need help, either to find something to work on, or with any technical problem, the easiest way to get it is via internals.tidb.io, the forum for TiDB developers.
140+
If you need help, either to find something to work on, or with any technical problem, the easiest way to get it is via internals.tidb.io, the forum for TiDB developers.
142141

143142
You can also ask in Slack. We monitor the #client-rust channel on the [tikv-wg slack](https://tikv.org/chat).
144143

0 commit comments

Comments
 (0)