48个版本 (30个稳定版)
5.0.3+20230114 | 2023年8月23日 |
---|---|
5.0.2+20230114 | 2023年3月16日 |
5.0.2-beta-1+20230114 | 2023年1月25日 |
4.0.1+20220222 | 2022年9月14日 |
0.1.2+20150303 | 2015年3月25日 |
#43 在 数据库接口
1,508 每月下载量
用于 2 crate
1MB
11K SLoC
该 google-bigquery2
库允许访问Google bigquery服务的所有功能。
本文档由bigquery crate版本5.0.3+20230114生成,其中20230114是mako代码生成器v5.0.3构建的bigquery:v2模式的确切修订。
有关bigquery v2 API的所有其他信息,请参阅官方文档网站。
特性
从中心枢纽轻松处理以下资源...
- 数据集
- 删除,获取,插入,列表,修补和更新
- 作业
- 取消,删除,获取,获取查询结果,插入,列表和查询
- 模型
- 删除,获取,列表和修补
- 项目
- 获取服务帐户 和 列出
- 例程
- 删除、获取、插入、列出 和 更新
- 行访问策略
- 获取 IAM 策略、列出、设置 IAM 策略 和 测试 IAM 权限
- 表数据
- 插入全部 和 列出
- 表格
- 删除、获取、获取 IAM 策略、插入、列出、修补、设置 IAM 策略、测试 IAM 权限 和 更新
支持由 ... 上传
本库的结构
API 被组织成以下主要项目
所有 结构 都用适用特性标记,以便进一步分类并便于浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或具体地 ...
let r = hub.tables().delete(...).doit().await
let r = hub.tables().get(...).doit().await
let r = hub.tables().get_iam_policy(...).doit().await
let r = hub.tables().insert(...).doit().await
let r = hub.tables().list(...).doit().await
let r = hub.tables().patch(...).doit().await
let r = hub.tables().set_iam_policy(...).doit().await
let r = hub.tables().test_iam_permissions(...).doit().await
let r = hub.tables().update(...).doit().await
资源(resource)和活动(activity)调用创建了构建器。第二个处理Activities
,支持各种方法来配置即将进行的操作(此处未显示)。它设计成所有必需的参数必须立即指定(即 (...)
),而所有可选参数则可以根据需要逐步构建。doit()
方法执行与服务器实际的通信并返回相应的结果。
使用方法
设置您的项目
要使用此库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-bigquery2 = "*"
serde = "^1.0"
serde_json = "^1.0"
完整示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_bigquery2 as bigquery2;
use bigquery2::{Result, Error};
use std::default::Default;
use bigquery2::{Bigquery, 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 = Bigquery::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// 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.tables().get("projectId", "datasetId", "tableId")
.view("ipsum")
.selected_fields("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")
。
支持上传的方法可以使用多达2种不同的协议:简单和可恢复。每种协议的独特性通过定制的doit(...)
方法来表示,这些方法分别命名为upload(...)
和upload_resumable(...)
。
定制和回调
您可以通过向Method Builder提供委托并在最终调用doit()
之前来改变doit()
方法的调用方式。相应的方程序将调用以提供进度信息,并确定系统在失败时应否重试。
委托特质(delegate trait)默认实现,让您可以以最小的努力进行自定义。
服务器请求中的可选部分
本库提供的所有结构都旨在通过json进行编码和解码,以便通过RequestValue和ResponseResult。使用可选部分来表示部分请求或响应是有效的。大多数可选部分被认为是Parts,可以通过名称识别,这些部分将发送到服务器,以指示请求的设置部分或响应中希望包含的部分。
构建器参数
使用方法构建器,您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受单个参数,以下陈述对它适用。
参数将始终被复制或克隆到构建器中,以确保它们与原始生命周期的独立性。
许可协议
bigquery2库由Sebastian Thiel生成,并置于MIT许可之下。您可以在存储库的许可文件中阅读全文。
依赖项
~17–28MB
~535K SLoC