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

本文档是根据 SQL Admin 库版本 5.0.5+20240618 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 sqladmin:v1 架构的精确修订版本。

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

功能

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

• 备份运行
• 删除，获取，插入 和 列出
• 连接
• 生成临时连接 和 获取
• 数据库
• 删除，获取，插入，列出，修补 和 更新
• 标志
• 列出
• 实例
• 获取 SSRS 租约，添加服务器 CA，克隆，删除，降级，降级主实例，导出，故障转移，获取，导入，插入，列出，列出服务器 CA，修补，提升副本，重新加密，释放 SSRS 租约，重置 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(...).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().reencrypt(...).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().switchover(...).doit().await
let r = hub.instances().truncate_log(...).doit().await
let r = hub.instances().update(...).doit().await
let r = hub.operations().cancel(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.operations().list(...).doit().await
let r = hub.projects().instances_perform_disk_shrink(...).doit().await
let r = hub.projects().instances_reschedule_maintenance(...).doit().await
let r = hub.projects().instances_reset_replica_size(...).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(...)调用创建构建器。第二个处理Activities，支持各种方法来配置即将进行的操作（此处未显示）。它被设计成必须立即指定所有必需的参数（即(...)），而所有可选的参数都可以根据需要构建。doit()方法执行与服务器实际通信，并返回相应的结果。

使用方法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_sqladmin1 as sqladmin1;
use sqladmin1::api::User;
use sqladmin1::{Result, Error};
use std::default::Default;
use sqladmin1::{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枚举提供，作为doit()方法的返回值，或者作为可能的中途结果传递给Hub Delegate，或Authenticator Delegate。

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

上传和下载

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

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

自定义和回调

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

代理特质 默认实现，允许您以最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下陈述适用于这些参数。

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

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

Cargo 功能

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

许可证

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