TiKV 客户端 (Rust)

本 crate 为 TiKV（>= v5.0.0）集群提供易于使用的客户端，TiKV 是一个用 Rust 编写的分布式、事务性键值数据库。

本 crate 允许您连接到 TiKV 集群，并使用事务性或原始（简单 get/put 风格，不保证事务一致性）API 访问和更新数据。

TiKV Rust 客户端是一个由 TiKV 作者维护的开源（Apache 2）项目。我们欢迎贡献，更多信息见下文。

请注意，当前版本不适合生产使用 - API 尚未稳定，crate 还未在实际使用中进行彻底测试。

入门

TiKV 客户端是一个 Rust 库（crate）。要在项目中使用此 crate，请将以下依赖项添加到您的 Cargo.toml

[dependencies]
tikv-client = "0.3"

先决条件

• rust >= 1.56.1，需要 hashbrown-v0.12.1

使用客户端crate的一般流程是创建一个原始或事务客户端对象（可以进行配置），然后使用客户端对象发送命令，或者用它来创建事务对象。在后一种情况下，事务是通过各种命令构建的，然后提交（或回滚）。

示例

原始模式

use tikv_client::RawClient;

let client = RawClient::new(vec!["127.0.0.1:2379"], None).await?;
client.put("key".to_owned(), "value".to_owned()).await?;
let value = client.get("key".to_owned()).await?;

事务模式

use tikv_client::TransactionClient;

let txn_client = TransactionClient::new(vec!["127.0.0.1:2379"], None).await?;
let mut txn = txn_client.begin_optimistic().await?;
txn.put("key".to_owned(), "value".to_owned()).await?;
let value = txn.get("key".to_owned()).await?;
txn.commit().await?;

由于TiKV客户端提供了一个异步API，您需要使用异步运行时（我们目前仅支持Tokio）。有关完整示例，请参阅getting-started.md。

API摘要

TiKV Rust客户端支持多个抽象级别。使用客户端最方便的方式是通过RawClient和TransactionClient。这提供了一个非常高级的API，主要抽象了存储的分布式特性，并为所有协议提供了合理的默认值。此接口可以进行配置，主要是在创建客户端或事务对象时通过Config和TransactionOptions结构体进行。使用某些选项，您可以自己接管协议的部分（如重试失败的消息）。

最低级别的抽象是直接创建和发送gRPC消息到TiKV（和PD）节点。`tikv-client-store`和`tikv-client-pd`crate使这比直接使用protobuf定义和gRPC库更容易，但给您相同的控制级别。

在这些抽象级别之间，您可以向TiKV集群发送和接收单个消息，但可以利用库代码执行常见操作，如将数据解析到区域并因此到集群中的节点，或者重试失败的消息。这对于测试TiKV集群或某些高级用例可能很有用。请参阅此API的`client_rust::request`模块，以及`client_rust::raw::lowering`和`client_rust::transaction::lowering`模块以获取创建请求对象的便捷方法。

本文档的其余部分仅描述RawClient/TransactionClient API。

重要提示：不建议或支持在同一个数据库上同时使用原始和事务API。

类型

Key：存储中的键。`String`和`Vec<u8>`实现了`Into<Key>`，因此您可以直接将它们传递到客户端函数中。

Value：存储中的值；只是`Vec<u8>``的别名。

cargo install cargo-nextest --locked

tiup playground nightly --mode tikv-slim

PD_ADDRS="127.0.0.1:2379" cargo test --package tikv-client --test integration_tests --features integration-tests