Struct gcp_bigquery_client::dataset::DatasetApi

pub struct DatasetApi { /* private fields */ }

A dataset API handler.

Implementations

impl DatasetApi

pub async fn create(&self, dataset: Dataset) -> Result<Dataset, BQError>

Creates a new empty dataset.

Argument

• dataset - The dataset to create

Example

let (ref project_id, ref dataset_id, ref _table_id, ref sa_key) = env_vars();
let dataset_id = &format!("{}_dataset", dataset_id);

let client = Client::from_service_account_key_file(sa_key).await;

client.dataset().create(Dataset::new(project_id, dataset_id)).await?;

pub async fn list(
    &self,
    project_id: &str,
    options: ListOptions
) -> Result<Datasets, BQError>

Lists all datasets in the specified project to which the user has been granted the READER dataset role.

Arguments

• project_id - Project ID of the datasets to be listed
• options - Options

Example

let (ref project_id, ref dataset_id, ref _table_id, ref sa_key) = env_vars();
let dataset_id = &format!("{}_dataset", dataset_id);

let client = Client::from_service_account_key_file(sa_key).await;

let datasets = client.dataset().list(project_id, ListOptions::default().all(true)).await?;
for dataset in datasets.datasets.iter() {
    // Do some stuff
}

pub async fn delete(
    &self,
    project_id: &str,
    dataset_id: &str,
    delete_contents: bool
) -> Result<(), BQError>

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.

Arguments

• project_id - Project ID of the dataset being deleted
• dataset_id - Dataset ID of dataset being deleted
• delete_contents - If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False

Example

let (ref project_id, ref dataset_id, ref _table_id, ref sa_key) = env_vars();
let dataset_id = &format!("{}_dataset", dataset_id);

let client = Client::from_service_account_key_file(sa_key).await;

client.dataset().create(Dataset::new(project_id, dataset_id)).await?;
client.dataset().delete(project_id, dataset_id, true).await?;

pub async fn delete_if_exists(
    &self,
    project_id: &str,
    dataset_id: &str,
    delete_contents: bool
) -> bool

Deletes the dataset specified by the datasetId value and returns true or returs false when the dataset doesn’t exist. 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.

Arguments

• project_id - Project ID of the dataset being deleted
• dataset_id - Dataset ID of dataset being deleted
• delete_contents - If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False

Example

let (ref project_id, ref dataset_id, ref _table_id, ref sa_key) = env_vars();
let dataset_id = &format!("{}_dataset", dataset_id);

let client = Client::from_service_account_key_file(sa_key).await;

client.dataset().delete_if_exists(project_id, dataset_id, true);

pub async fn get(
    &self,
    project_id: &str,
    dataset_id: &str
) -> Result<Dataset, BQError>

Returns the dataset specified by datasetID.

Arguments

• project_id - Project ID of the requested dataset
• dataset_id - Dataset ID of the requested dataset

Example

let (ref project_id, ref dataset_id, ref _table_id, ref sa_key) = env_vars();
let dataset_id = &format!("{}_dataset", dataset_id);

let client = Client::from_service_account_key_file(sa_key).await;

client.dataset().create(Dataset::new(project_id, dataset_id)).await?;
let dataset = client.dataset().get(project_id, dataset_id).await?;

pub async fn patch(
    &self,
    project_id: &str,
    dataset_id: &str,
    dataset: Dataset
) -> Result<Dataset, BQError>

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.

Arguments

• dataset - The request body contains an instance of Dataset.

pub async fn update(
    &self,
    project_id: &str,
    dataset_id: &str,
    dataset: Dataset
) -> Result<Dataset, BQError>

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.

Arguments

• dataset - The request body contains an instance of Dataset.

pub async fn information_schema_schemata(
    &self,
    project_id: &str,
    region: &str
) -> Result<Vec<Schemata>, BQError>

Trait Implementations

impl Clone for DatasetApi

fn clone(&self) -> DatasetApi

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.