Crate google_bigquery2 [−] [src]
This documentation was generated from bigquery crate version 1.0.5+20170511, where 20170511 is the exact revision of the bigquery:v2 schema built by the mako code generator v1.0.5.
Everything else about the bigquery v2 API can be found at the official documentation site. The original source code is on github.
Features
Handle the following Resources with ease from the central hub ...
- datasets
- jobs
- projects
- tabledata
- insert all and list
- tables
Upload supported by ...
Not what you are looking for ? Find all other Google APIs in their Rust documentation index.
Structure of this Library
The API is structured into the following primary items:
- Hub
- a central object to maintain state and allow accessing all Activities
- creates Method Builders which in turn allow access to individual Call Builders
- Resources
- primary types that you can apply Activities to
- a collection of properties and Parts
- Parts
- a collection of properties
- never directly used in Activities
- Activities
- operations to apply to Resources
All structures are marked with applicable traits to further categorize them and ease browsing.
Generally speaking, you can invoke Activities like this:
let r = hub.resource().activity(...).doit()
Or specifically ...
let r = hub.tables().update(...).doit() let r = hub.tables().insert(...).doit() let r = hub.tables().list(...).doit() let r = hub.tables().delete(...).doit() let r = hub.tables().get(...).doit() let r = hub.tables().patch(...).doit()
The resource()
and activity(...)
calls create builders. The second one dealing with Activities
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
specified right away (i.e. (...)
), whereas all optional ones can be build up as desired.
The doit()
method performs the actual communication with the server and returns the respective result.
Usage
Setting up your Project
To use this library, you would put the following lines into your Cargo.toml
file:
[dependencies]
google-bigquery2 = "*"
A complete example
extern crate hyper; extern crate hyper_rustls; extern crate yup_oauth2 as oauth2; extern crate google_bigquery2 as bigquery2; use bigquery2::Table; use bigquery2::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use bigquery2::Bigquery; // Get an ApplicationSecret instance by some means. It contains the `client_id` and // `client_secret`, among other things. let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate, hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), <MemoryStorage as Default>::default(), None); let mut hub = Bigquery::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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 = Table::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.tables().update(req, "projectId", "datasetId", "tableId") .doit(); 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::MissingAPIKey |Error::MissingToken(_) |Error::Cancelled |Error::UploadSizeLimitExceeded(_, _) |Error::Failure(_) |Error::BadRequest(_) |Error::FieldClash(_) |Error::JsonDecodeError(_, _) => println!("{}", e), }, Ok(res) => println!("Success: {:?}", res), }
Handling Errors
All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.
Uploads and Downloads
If a method supports downloads, the response body, which is part of the Result, should be
read by you to obtain the media.
If such a method also supports a Response Result, it will return that by default.
You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
this call: .param("alt", "media")
.
Methods supporting uploads can do so using up to 2 different protocols:
simple and resumable. The distinctiveness of each is represented by customized
doit(...)
methods, which are then named upload(...)
and upload_resumable(...)
respectively.
Customization and Callbacks
You may alter the way an doit()
method is called by providing a delegate to the
Method Builder before making the final doit()
call.
Respective methods will be called to provide progress information, as well as determine whether the system should
retry on failure.
The delegate trait is default-implemented, allowing you to customize it with minimal effort.
Optional Parts in Server-Requests
All structures provided by this library are made to be enocodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.
Builder Arguments
Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.
- PODs are handed by copy
- strings are passed as
&str
- request values are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
Structs
Bigquery |
Central instance to access all Bigquery related resource activities |
BigtableColumn |
There is no detailed description. |
BigtableColumnFamily |
There is no detailed description. |
BigtableOptions |
There is no detailed description. |
CsvOptions |
There is no detailed description. |
Dataset |
There is no detailed description. |
DatasetAccess |
[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; |
DatasetDeleteCall |
Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. |
DatasetGetCall |
Returns the dataset specified by datasetID. |
DatasetInsertCall |
Creates a new empty dataset. |
DatasetList |
There is no detailed description. |
DatasetListCall |
Lists all datasets in the specified project to which you have been granted the READER dataset role. |
DatasetListDatasets |
An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project. |
DatasetMethods |
A builder providing access to all methods supported on dataset resources.
It is not used directly, but through the |
DatasetPatchCall |
Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics. |
DatasetReference |
There is no detailed description. |
DatasetUpdateCall |
Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. |
DefaultDelegate |
A delegate with a conservative default implementation, which is used if no other delegate is set. |
ErrorProto |
There is no detailed description. |
ErrorResponse |
A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound |
ExplainQueryStage |
There is no detailed description. |
ExplainQueryStep |
There is no detailed description. |
ExternalDataConfiguration |
There is no detailed description. |
GetQueryResultsResponse |
There is no detailed description. |
GoogleSheetsOptions |
There is no detailed description. |
Job |
There is no detailed description. |
JobCancelCall |
Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. |
JobCancelResponse |
There is no detailed description. |
JobConfiguration |
There is no detailed description. |
JobConfigurationExtract |
There is no detailed description. |
JobConfigurationLoad |
There is no detailed description. |
JobConfigurationQuery |
There is no detailed description. |
JobConfigurationTableCopy |
There is no detailed description. |
JobGetCall |
Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. |
JobGetQueryResultCall |
Retrieves the results of a query job. |
JobInsertCall |
Starts a new asynchronous job. Requires the Can View project role. |
JobList |
There is no detailed description. |
JobListCall |
Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. |
JobListJobs |
List of jobs that were requested. |
JobMethods |
A builder providing access to all methods supported on job resources.
It is not used directly, but through the |
JobQueryCall |
Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. |
JobReference |
There is no detailed description. |
JobStatistics |
There is no detailed description. |
JobStatistics2 |
There is no detailed description. |
JobStatistics3 |
There is no detailed description. |
JobStatistics4 |
There is no detailed description. |
JobStatus |
There is no detailed description. |
JsonObject |
Represents a single JSON object. |
JsonValue |
There is no detailed description. |
MethodInfo |
Contains information about an API request. |
MultiPartReader |
Provides a |
ProjectList |
There is no detailed description. |
ProjectListCall |
Lists all projects to which you have been granted any project role. |
ProjectListProjects |
Projects to which you have at least READ access. |
ProjectMethods |
A builder providing access to all methods supported on project resources.
It is not used directly, but through the |
ProjectReference |
There is no detailed description. |
QueryParameter |
There is no detailed description. |
QueryParameterType |
There is no detailed description. |
QueryParameterTypeStructTypes |
[Optional] The types of the fields of this struct, in order, if this is a struct. |
QueryParameterValue |
There is no detailed description. |
QueryRequest |
There is no detailed description. |
QueryResponse |
There is no detailed description. |
Streamingbuffer |
There is no detailed description. |
Table |
There is no detailed description. |
TableCell |
There is no detailed description. |
TableDataInsertAllRequest |
There is no detailed description. |
TableDataInsertAllRequestRows |
The rows to insert. |
TableDataInsertAllResponse |
There is no detailed description. |
TableDataInsertAllResponseInsertErrors |
An array of errors for rows that were not inserted. |
TableDataList |
There is no detailed description. |
TableDeleteCall |
Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. |
TableFieldSchema |
There is no detailed description. |
TableGetCall |
Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. |
TableInsertCall |
Creates a new, empty table in the dataset. |
TableList |
There is no detailed description. |
TableListCall |
Lists all tables in the specified dataset. Requires the READER dataset role. |
TableListTables |
Tables in the requested dataset. |
TableListTablesView |
Additional details for a view. |
TableMethods |
A builder providing access to all methods supported on table resources.
It is not used directly, but through the |
TablePatchCall |
Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics. |
TableReference |
There is no detailed description. |
TableRow |
There is no detailed description. |
TableSchema |
There is no detailed description. |
TableUpdateCall |
Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. |
TabledataInsertAllCall |
Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role. |
TabledataListCall |
Retrieves table data from a specified set of rows. Requires the READER dataset role. |
TabledataMethods |
A builder providing access to all methods supported on tabledata resources.
It is not used directly, but through the |
TimePartitioning |
There is no detailed description. |
UserDefinedFunctionResource |
There is no detailed description. |
ViewDefinition |
There is no detailed description. |
Enums
Error | |
Scope |
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token. |
Traits
CallBuilder |
Identifies types which represent builders for a particular resource method |
Delegate |
A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation. |
Hub |
Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily. |
MethodsBuilder |
Identifies types for building methods of a particular resource type |
NestedType |
Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness. |
Part |
Identifies types which are only used as part of other types, which
usually are carrying the |
ReadSeek |
A utility to specify reader types which provide seeking capabilities too |
RequestValue |
Identifies types which are used in API requests. |
Resource |
Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API. |
ResponseResult |
Identifies types which are used in API responses. |
ToParts |
A trait for all types that can convert themselves into a parts string |
Functions
remove_json_null_values |
Type Definitions
Result |
A universal result type used as return for all calls. |