45 个版本 (27 个稳定版)
5.0.5+20240618 | 2024 年 6 月 27 日 |
---|---|
5.0.4+20240219 | 2024 年 3 月 5 日 |
5.0.3+20221209 | 2023 年 8 月 24 日 |
5.0.2+20221209 | 2023 年 3 月 17 日 |
0.1.2+20150109 | 2015 年 3 月 25 日 |
#2204 在 网页开发
2,534 每月下载量
用于 google-sqladmin1_beta4-cl…
1MB
13K SLoC
该 google-sqladmin1_beta4
库允许访问 Google SQL Admin 服务(v1beta4)的所有功能。
此文档是从 SQL Admincrate 版本 5.0.5+20240618 生成的,其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 sqladmin:v1beta4 架构的确切修订版。
有关 SQL Admin v1_beta4 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_beta4 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_sqladmin1_beta4 as sqladmin1_beta4;
use sqladmin1_beta4::api::User;
use sqladmin1_beta4::{Result, Error};
use std::default::Default;
use sqladmin1_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枚举提供,作为doit()方法的返回值,或者作为可能的中级结果传递给中心代理或认证代理。
当代理处理错误或中间值时,它们可能有机会指示系统重试。这使得系统可能对各种错误都具有弹性。
上传和下载
如果一种方法支持下载,您应该读取响应体,这是结果的一部分,以获取媒体。如果这种方法还支持响应结果,则默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您需要通过以下调用设置构建器:.param("alt", "media")
。
支持上传的方法可以使用最多2种不同的协议:简单和可恢复。每种协议的独特性由定制的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
自定义和回调
您可以通过在最终调用doit()
之前向方法构建器
提供一个代理来改变调用doit()
方法的方式。相应的将调用方法来提供进度信息,并确定系统在失败时是否应该重试。
代理特质默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都旨在通过json进行编码和解码。使用可选值来表示部分请求和响应是有效的。大多数可选值都是被认为是部分的,可以根据名称识别,这些部分将被发送到服务器以指示请求中的设置部分或响应中期望的部分。
构建器参数
使用方法构建器,您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受单个参数,以下语句为真。
参数将始终被复制或克隆到构建器中,以便它们与其原始的生命周期独立。
Cargo功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将无效。
许可证
sqladmin1_beta4 库由 Sebastian Thiel 创建,并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~12–23MB
~343K SLoC