google.cloud.bigquery.dataset.Dataset#

Methods

from_api_repr(resource) Factory: construct a dataset given its API representation
from_string(full_dataset_id) Construct a dataset from fully-qualified dataset ID.
model(model_id) Constructs a ModelReference.
table(table_id) Constructs a TableReference.
to_api_repr() Construct the API resource representation of this dataset

Attributes

access_entries Dataset’s access entries.
created Datetime at which the dataset was created (None until set from the server).
dataset_id Dataset ID.
default_table_expiration_ms Default expiration time for tables in the dataset (defaults to None).
description Description of the dataset as set by the user (defaults to None).
etag ETag for the dataset resource (None until set from the server).
friendly_name Title of the dataset as set by the user (defaults to None).
full_dataset_id ID for the dataset resource (None until set from the server)
labels Labels for the dataset.
location Location in which the dataset is hosted as set by the user (defaults to None).
modified Datetime at which the dataset was last modified (None until set from the server).
path URL path for the dataset based on project and dataset ID.
project Project ID of the project bound to the dataset.
reference A reference to this dataset.
self_link URL for the dataset resource (None until set from the server).


class google.cloud.bigquery.dataset.Dataset(dataset_ref)[source]#

Bases: object

Datasets are containers for tables.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets

Parameters:dataset_ref (Union[ DatasetReference, str, ]) – A pointer to a dataset. If dataset_ref is a string, it must include both the project ID and the dataset ID, separated by ..
access_entries#

Dataset’s access entries.

role augments the entity type and must be present unless the entity type is view.

Raises:
Type:

List[google.cloud.bigquery.dataset.AccessEntry]

created#

Datetime at which the dataset was created (None until set from the server).

Type:Union[datetime.datetime, None]
dataset_id#

Dataset ID.

Type:str
default_table_expiration_ms#

Default expiration time for tables in the dataset (defaults to None).

Raises:ValueError – For invalid value types.
Type:Union[int, None]
description#

Description of the dataset as set by the user (defaults to None).

Raises:ValueError – for invalid value types.
Type:Union[str, None]
etag#

ETag for the dataset resource (None until set from the server).

Type:Union[str, None]
friendly_name#

Title of the dataset as set by the user (defaults to None).

Raises:ValueError – for invalid value types.
Type:Union[str, None]
classmethod from_api_repr(resource)[source]#

Factory: construct a dataset given its API representation

Parameters:(Dict[str (resource) – object]): Dataset resource representation returned from the API
Returns:Dataset parsed from resource.
Return type:google.cloud.bigquery.dataset.Dataset
classmethod from_string(full_dataset_id)[source]#

Construct a dataset from fully-qualified dataset ID.

Parameters:full_dataset_id (str) – A fully-qualified dataset ID in standard SQL format. Must included both the project ID and the dataset ID, separated by ..
Returns:Dataset parsed from full_dataset_id.
Return type:Dataset

Examples

>>> Dataset.from_string('my-project-id.some_dataset')
Dataset(DatasetReference('my-project-id', 'some_dataset'))
Raises:ValueError – If full_dataset_id is not a fully-qualified dataset ID in standard SQL format.
full_dataset_id#

ID for the dataset resource (None until set from the server)

In the format project_id:dataset_id.

Type:Union[str, None]
labels#

Labels for the dataset.

This method always returns a dict. To change a dataset’s labels, modify the dict, then call google.cloud.bigquery.client.Client.update_dataset(). To delete a label, set its value to None before updating.

Raises:ValueError – for invalid value types.
Type:Dict[str, str]
location#

Location in which the dataset is hosted as set by the user (defaults to None).

Raises:ValueError – for invalid value types.
Type:Union[str, None]
model(model_id)#

Constructs a ModelReference.

Parameters:model_id (str) – the ID of the model.
Returns:A ModelReference for a model in this dataset.
Return type:google.cloud.bigquery.model.ModelReference
modified#

Datetime at which the dataset was last modified (None until set from the server).

Type:Union[datetime.datetime, None]
path#

URL path for the dataset based on project and dataset ID.

Type:str
project#

Project ID of the project bound to the dataset.

Type:str
reference#

A reference to this dataset.

Type:google.cloud.bigquery.dataset.DatasetReference

URL for the dataset resource (None until set from the server).

Type:Union[str, None]
table(table_id)#

Constructs a TableReference.

Parameters:table_id (str) – The ID of the table.
Returns:A table reference for a table in this dataset.
Return type:google.cloud.bigquery.table.TableReference
to_api_repr()[source]#

Construct the API resource representation of this dataset

Returns:The dataset represented as an API resource
Return type:Dict[str, object]