#grpc-client #grpc #database-client #mysql #client #vitess

vitess-grpc

Vitess gRPC 客户端库,由 Vitess proto 文件使用 tonic-build 自动生成

5 个不稳定版本

0.3.0+vitess-18.0.02023年11月11日
0.2.0+vitess-17.0.12023年8月16日
0.1.2+vitess-16.0.22023年6月19日
0.1.1 2023年6月19日
0.1.0 2023年6月5日

#1991 in 数据库接口

每月 39 次下载

MIT/Apache

785KB
16K SLoC

Vitess 的 gRPC 客户端

Crates.io Docs.rs Tests Checks

这是一个 Rust gRPC 客户端,用于 Vitess。它使用 tonic 从 Vitess proto 文件生成。

使用方法

要使用此软件包,请将以下内容添加到您的 Cargo.toml 中

[dependencies]
vitess-grpc = "0.3"
tokio = { version = "1.0", features = ["full"] }

示例

您可以在 examples 目录中找到此软件包的使用示例。

可以使用以下命令运行示例

cargo run --example <example_name>

可用的示例有

  • vstream-consumer:一个简单的 vstream 消费者,它打印收到的事件。

在运行示例之前,您需要本地启动 Vitess。一种简单的方法是使用 scripts/start-vttestserver 脚本,该脚本将在 Docker(或 Podman)中启动一个本地 Vitess 集群,并在您内部配置一个简单的模式供测试使用。

版本控制

此软件包的版本与 Vitess 的版本无关,但包含一个构建元数据部分(有关详细信息,请参阅 SemVer 文档),并将其设置为软件包生成的 Vitess 版本。例如,版本 0.3.0+vitess18.0.0 表示该软件包是从包含在 Vitess v18.0.0 中的 proto 文件生成的。

许可协议

目录中的文件是从 Vitess 仓库 复制的,并使用 Apache License,版本 2.0 许可。有关更多详细信息,请参阅 Vitess LICENSE 文件。

此存储库中其余的代码使用 MIT 许可证。有关更多详细信息,请参阅 LICENSE 文件。

Vitess 更新流程

当 Vitess 发布新版本时,应采取以下步骤来更新此软件包

  1. 将 vitess-grpc/Cargo.toml 中的 version 更新为新的 Vitess 版本。
  2. 运行 script/update-protos 来更新 vitess-grpc/proto 目录中的 proto 文件。
  3. 运行 cargo build 来确保 crate 构建成功。
  4. 运行 scripts/start-vttestserver 来启动一个用于测试的本地 Vitess 集群。
  5. 运行 cargo test 来确保测试通过。
  6. 通过运行 scripts/stop-vttestserver 来停止本地 Vitess 集群。
  7. 提交更改并将它们推送到 GitHub。
  8. 在 GitHub 上创建一个新版本。
  9. 使用 cargo publish 将 crate 发布到 crates.io。

依赖项

~4–6MB
~99K SLoC