Lib.rs

› 认证
#spanner #google #protocols #google-api

google-spanner1

一个完整的库，用于与Spanner（协议v1）交互

由 Sebastian Thiel 和 48位贡献者 编写

9个稳定版本

5.0.5+20240618 2024年6月27日
1.0.12+20190613 2019年12月9日
1.0.10+20190613 2019年7月5日
1.0.8+20180920 2018年10月14日
1.0.6+20170914 2017年9月27日

#306 in 认证

每月21次下载
用于 google-spanner1-cli

MIT 许可证

1.5MB
18K SLoC

google-spanner1 库允许访问 Google Spanner 服务所有功能。

此文档是从 Spanner crate 版本 5.0.5+20240618 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 spanner:v1 方案的精确修订。

有关 Spanner v1 API 的其他信息，请参阅 官方文档网站。

功能

从中央 枢纽 简单地处理以下 资源...

本库的结构

API 结构如下主要项

  • 枢纽
  • 资源
    • 可以将 活动 应用于其上的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性集合
      • 永远不会直接用于 活动
  • 活动
    • 应用于 资源 的操作

所有 结构 都标记有适用的特质，以进一步分类它们并简化浏览。

一般来说，您可以通过以下方式调用 活动

let r = hub.resource().activity(...).doit().await

或具体...

let r = hub.projects().instance_configs_operations_get(...).doit().await
let r = hub.projects().instance_configs_ssd_caches_operations_get(...).doit().await
let r = hub.projects().instance_configs_create(...).doit().await
let r = hub.projects().instance_configs_patch(...).doit().await
let r = hub.projects().instances_backups_operations_get(...).doit().await
let r = hub.projects().instances_backups_copy(...).doit().await
let r = hub.projects().instances_backups_create(...).doit().await
let r = hub.projects().instances_databases_operations_get(...).doit().await
let r = hub.projects().instances_databases_changequorum(...).doit().await
let r = hub.projects().instances_databases_create(...).doit().await
let r = hub.projects().instances_databases_patch(...).doit().await
let r = hub.projects().instances_databases_restore(...).doit().await
let r = hub.projects().instances_databases_update_ddl(...).doit().await
let r = hub.projects().instances_instance_partitions_operations_get(...).doit().await
let r = hub.projects().instances_instance_partitions_create(...).doit().await
let r = hub.projects().instances_instance_partitions_patch(...).doit().await
let r = hub.projects().instances_operations_get(...).doit().await
let r = hub.projects().instances_create(...).doit().await
let r = hub.projects().instances_move(...).doit().await
let r = hub.projects().instances_patch(...).doit().await

资源 resource() 和活动 activity(...) 调用创建了构建器。第二个处理 Activities 的调用支持各种配置即将进行的操作的方法（此处未展示）。它设计为必须立即指定所有必需的参数（即 (...)），而所有可选参数都可以按需 构建。doit() 方法执行与服务器的实际通信并返回相应的结果。

用法

设置你的项目

要使用此库，你需要在你的 Cargo.toml 文件中放入以下行

[dependencies]
google-spanner1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_spanner1 as spanner1;
use spanner1::api::Backup;
use spanner1::{Result, Error};
use std::default::Default;
use spanner1::{Spanner, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Spanner::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Backup::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().instances_backups_create(req, "parent")
             .add_encryption_config_kms_key_names("magna")
             .encryption_config_kms_key_name("no")
             .encryption_config_encryption_type("ipsum")
             .backup_id("voluptua.")
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都作为 Result 枚举提供，作为 doit() 方法的返回值，或者作为可能的中级结果传递给 Hub Delegate，或者 Authenticator Delegate。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果某个方法支持下载，则应该由您读取响应体来获取媒体，该响应体是 Result 的一部分。如果此方法还支持 Response Result，则默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载，您必须通过执行此调用来设置构建器：.param("alt", "media")。

支持上传的方法可以使用最多两种不同的协议进行：简单 和 可恢复。每种方法的独特性由定制的 doit(...) 方法表示，分别命名为 upload(...) 和 upload_resumable(...)。

定制和回调

您可以通过向 Method Builder 提供一个 delegate 来改变 doit() 方法的调用方式，在执行最终的 doit() 调用之前。将调用相应的方法以提供进度信息，并确定系统在失败时是否应该重试。

delegate trait 默认实现，让您可以以最少的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都旨在通过 编码器 和 解码器 以 json 格式进行编码和解码。使用可选参数来表示部分请求和响应是有效的。大多数可选参数被认为是 部分，可以通过名称识别，这些部分将被发送到服务器，以指示请求的设置部分或响应中期望的部分。

构建器参数

通过使用 方法构建器，您可以通过重复调用其方法来准备一个动作调用。这些方法总是接受单个参数，以下陈述对此成立。

  • POD 通过复制传递
  • 字符串作为 &str 传递
  • 请求值 被移动

参数将被复制或克隆到构建器中，以便它们与它们的原始生命周期独立。

Cargo 功能

  • utoipa - 添加对 utoipa 的支持，并从所有类型中派生 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入并注册所需类型，否则生成的 openapi 规范将无效。

许可证

spanner1 库由 Sebastian Thiel 生成，并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。

依赖关系

~12–23MB
~343K SLoC