GoogleApi.BigQuery.V2.Api.Datasets (google_api_big_query v0.70.1) View Source

API calls for all endpoints tagged Datasets.

Link to this section Summary

Functions

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.

Lists all datasets in the specified project to which you have been granted the READER dataset role.

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.

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.

Link to this section Functions

Link to this function

bigquery_datasets_delete(connection, project_id, dataset_id, optional_params \\ [], opts \\ [])

View Source

Specs

bigquery_datasets_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Project ID of the dataset being deleted
  • dataset_id (type: String.t) - Dataset ID of dataset being deleted
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :deleteContents (type: boolean()) - If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

bigquery_datasets_get(connection, project_id, dataset_id, optional_params \\ [], opts \\ [])

View Source

Specs

bigquery_datasets_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQuery.V2.Model.Dataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the dataset specified by datasetID.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Project ID of the requested dataset
  • dataset_id (type: String.t) - Dataset ID of the requested dataset
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.Dataset{}} on success
  • {:error, info} on failure
Link to this function

bigquery_datasets_insert(connection, project_id, optional_params \\ [], opts \\ [])

View Source

Specs

bigquery_datasets_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.BigQuery.V2.Model.Dataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new empty dataset.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Project ID of the new dataset
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.BigQuery.V2.Model.Dataset.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.Dataset{}} on success
  • {:error, info} on failure
Link to this function

bigquery_datasets_list(connection, project_id, optional_params \\ [], opts \\ [])

View Source

Specs

bigquery_datasets_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.BigQuery.V2.Model.DatasetList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all datasets in the specified project to which you have been granted the READER dataset role.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Project ID of the datasets to be listed
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :all (type: boolean()) - Whether to list all datasets, including hidden ones
    • :filter (type: String.t) - An expression for filtering the results of the request by label. The syntax is "labels.<name>[:<value>]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.
    • :maxResults (type: integer()) - The maximum number of results to return
    • :pageToken (type: String.t) - Page token, returned by a previous call, to request the next page of results
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.DatasetList{}} on success
  • {:error, info} on failure
Link to this function

bigquery_datasets_patch(connection, project_id, dataset_id, optional_params \\ [], opts \\ [])

View Source

Specs

bigquery_datasets_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQuery.V2.Model.Dataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Project ID of the dataset being updated
  • dataset_id (type: String.t) - Dataset ID of the dataset being updated
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.BigQuery.V2.Model.Dataset.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.Dataset{}} on success
  • {:error, info} on failure
Link to this function

bigquery_datasets_update(connection, project_id, dataset_id, optional_params \\ [], opts \\ [])

View Source

Specs

bigquery_datasets_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQuery.V2.Model.Dataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Project ID of the dataset being updated
  • dataset_id (type: String.t) - Dataset ID of the dataset being updated
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.BigQuery.V2.Model.Dataset.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.Dataset{}} on success
  • {:error, info} on failure