|
19 | 19 | //! > in active development. You're encouraged to use this library for testing and help us find
|
20 | 20 | //! > problems!
|
21 | 21 | //!
|
22 |
| -//! This crate provides Rust bindings to [TiKV](https://github.com/tikv/tikv), a distributed |
23 |
| -//! transactional Key-Value database written in Rust. |
| 22 | +//! This crate provides a clean, ready to use client for [TiKV](https://github.com/tikv/tikv), a |
| 23 | +//! distributed transactional Key-Value database written in Rust. |
24 | 24 | //!
|
25 | 25 | //! With this crate you can easily connect to any TiKV deployment, interact with it, and mutate the
|
26 | 26 | //! data it contains.
|
|
52 | 52 | //! This crate offers both [**raw**](raw/index.html) and
|
53 | 53 | //! [**transactional**](transaction/index.html) APIs. You should choose just one for your system.
|
54 | 54 | //!
|
55 |
| -//! The *consequence* of supporting transactions is increased overhead of coordination with `pd` |
56 |
| -//! for timestamp acquisition. This is approximately 1 RTT. |
| 55 | +//! The *consequence* of supporting transactions is increased overhead of coordination with the |
| 56 | +//! placement driver for timestamp acquisition. This is approximately 1 RTT. |
57 | 57 | //!
|
58 | 58 | //! *While it is possible to use both APIs at the same time, doing so is unsafe and unsupported.*
|
59 | 59 | //!
|
|
62 | 62 | //!
|
63 | 63 | //! ### Transactional
|
64 | 64 | //!
|
65 |
| -//! The [transactional](transaction/index.html) API supports **transactions** via Multi-View |
| 65 | +//! The [transactional](transaction/index.html) API supports **transactions** via Multi-Version |
66 | 66 | //! Concurrency Control (MVCC).
|
67 | 67 | //!
|
68 | 68 | //! **Best when you mostly do** complex sets of actions, actions which may require a rollback,
|
|
78 | 78 | //! transactional abilities.
|
79 | 79 | //!
|
80 | 80 | //! **Best when you mostly do** single row changes, and have very limited cross-row (eg. foreign
|
81 |
| -//! key) requirements. |
| 81 | +//! key) requirements. You will not be able to use transactions with this API. |
82 | 82 | //!
|
83 | 83 | //! ```rust
|
84 | 84 | //! use tikv_client::{*, raw::*};
|
|
0 commit comments