google-sql1_beta4 库允许访问 Google SQL Admin 服务所有功能。

本文档是从 SQL Admin crate 版本 5.0.5+20200331 生成的，其中 20200331 是由 mako 代码生成器 v5.0.5 构建的 sql:v1beta4 架构的确切修订版。

关于 SQL Admin v1_beta4 API 的其他信息可以在 官方文档网站 找到。

功能

从中央 中心 轻松处理以下 资源 ...

• 备份运行
• 删除，获取，插入 和 列表
• 数据库
• 删除，获取，插入，列表，修补 和 更新
• 标志
• 列表
• 实例
• 添加服务器CA，克隆，删除，降级主节点，导出，故障转移，获取，导入，插入，列出，列出服务器CA，修补，提升副本，重置SSL配置，重启，恢复备份，轮换服务器CA，启动副本，停止副本，截断日志和更新
• 操作
• 获取和列出
• 项目
• 实例重新安排维护，实例启动外部同步和实例验证外部同步设置
• SSL证书
• 创建临时，删除，获取，插入和列出
• 层级
• 列表
• 用户
• 删除，插入，列出和更新

本库结构

API结构如下主要项目

• 中心节点
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，这又允许访问单个调用构建器
• 资源
  • 你可以将其应用于活动的主要类型
  • 属性和部分的集合
  • 部分
    • 属性集合
    • 从未在活动中直接使用
• 活动
  • 应用于资源的操作

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

一般来说，您可以像这样调用活动

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

或者具体来说...

let r = hub.backup_runs().delete(...).doit().await
let r = hub.backup_runs().insert(...).doit().await
let r = hub.databases().delete(...).doit().await
let r = hub.databases().insert(...).doit().await
let r = hub.databases().patch(...).doit().await
let r = hub.databases().update(...).doit().await
let r = hub.instances().add_server_ca(...).doit().await
let r = hub.instances().clone(...).doit().await
let r = hub.instances().delete(...).doit().await
let r = hub.instances().demote_master(...).doit().await
let r = hub.instances().export(...).doit().await
let r = hub.instances().failover(...).doit().await
let r = hub.instances().import(...).doit().await
let r = hub.instances().insert(...).doit().await
let r = hub.instances().patch(...).doit().await
let r = hub.instances().promote_replica(...).doit().await
let r = hub.instances().reset_ssl_config(...).doit().await
let r = hub.instances().restart(...).doit().await
let r = hub.instances().restore_backup(...).doit().await
let r = hub.instances().rotate_server_ca(...).doit().await
let r = hub.instances().start_replica(...).doit().await
let r = hub.instances().stop_replica(...).doit().await
let r = hub.instances().truncate_log(...).doit().await
let r = hub.instances().update(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.operations().list(...).doit().await
let r = hub.projects().instances_reschedule_maintenance(...).doit().await
let r = hub.projects().instances_start_external_sync(...).doit().await
let r = hub.ssl_certs().delete(...).doit().await
let r = hub.users().delete(...).doit().await
let r = hub.users().insert(...).doit().await
let r = hub.users().update(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_sql1_beta4 as sql1_beta4;
use sql1_beta4::api::User;
use sql1_beta4::{Result, Error};
use std::default::Default;
use sql1_beta4::{SQLAdmin, 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 = SQLAdmin::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 = User::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.users().update(req, "project", "instance")
             .name("no")
             .host("ipsum")
             .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枚举，或者作为可能的中间结果传递给Hub Delegate或Authenticator Delegate。

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

上传和下载

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

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

自定义和回调

您可以通过向 方法构建器 提供一个 委托 来修改 doit() 方法的调用方式。在执行最终的 doit() 调用之前。相应的方法将被调用以提供进度信息，以及确定系统是否应在失败时重试。

委托特质 默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用 方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法将始终接受一个参数，以下陈述是正确的。

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

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

Cargo 功能

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

许可证

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