TiKV客户端（Rust）

本crate提供了一个易于使用的TiKV客户端，TiKV是一个用Rust编写的分布式、事务型键值数据库。

此crate允许您连接到TiKV(>= v5.0.0) 集群，并使用事务型或原始（简单的get/put风格，不带事务一致性保证）API来访问和更新您的数据。

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

请注意，当前版本不适用于生产使用——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` 插件使得使用 protobuf 定义和直接使用 gRPC 库相比更容易，但您将拥有相同级别的控制。

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

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

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

类型

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

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