Dataset(dataset_ref)Datasets are containers for tables.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#resource-dataset
Parameter
| Name | Description |
| dataset_ref |
Union[google.cloud.bigquery.dataset.DatasetReference, str]
A pointer to a dataset. If |
Inheritance
builtins.object > DatasetProperties
access_entries
List[google.cloud.bigquery.dataset.AccessEntry]: Dataset's access entries.
role augments the entity type and must be present unless the
entity type is view or routine.
| Type | Description |
| TypeError | If 'value' is not a sequence |
| ValueError | If any item in the sequence is not an AccessEntry. |
created
Union[datetime.datetime, None]: Datetime at which the dataset was
created (:data:None until set from the server).
dataset_id
str: Dataset ID.
default_encryption_configuration
google.cloud.bigquery.encryption_configuration.EncryptionConfiguration: Custom encryption configuration for all tables in the dataset.
Custom encryption configuration (e.g., Cloud KMS keys) or :data:None
if using default encryption.
See protecting data with Cloud KMS keys
<https://cloud.google.com/bigquery/docs/customer-managed-encryption>;_
in the BigQuery documentation.
default_partition_expiration_ms
Optional[int]: The default partition expiration for all partitioned tables in the dataset, in milliseconds.
Once this property is set, all newly-created partitioned tables in
the dataset will have an time_paritioning.expiration_ms property
set to this value, and changing the value will only affect new
tables, not existing ones. The storage in a partition will have an
expiration time of its partition time plus this value.
Setting this property overrides the use of
default_table_expiration_ms for partitioned tables: only one of
default_table_expiration_ms and
default_partition_expiration_ms will be used for any new
partitioned table. If you provide an explicit
time_partitioning.expiration_ms when creating or updating a
partitioned table, that value takes precedence over the default
partition expiration time indicated by this property.
default_table_expiration_ms
Union[int, None]: Default expiration time for tables in the dataset
(defaults to :data:None).
| Type | Description |
| ValueError | For invalid value types. |
description
Optional[str]: Description of the dataset as set by the user
(defaults to :data:None).
| Type | Description |
| ValueError | for invalid value types. |
etag
Union[str, None]: ETag for the dataset resource (:data:None until
set from the server).
friendly_name
Union[str, None]: Title of the dataset as set by the user
(defaults to :data:None).
| Type | Description |
| ValueError | for invalid value types. |
full_dataset_id
Union[str, None]: ID for the dataset resource (:data:None until
set from the server)
In the format project_id:dataset_id.
labels
Dict[str, str]: Labels for the dataset.
This method always returns a dict. To change a dataset's labels,
modify the dict, then call
xref_update_dataset. To delete
a label, set its value to :data:None before updating.
| Type | Description |
| ValueError | for invalid value types. |
location
Union[str, None]: Location in which the dataset is hosted as set by
the user (defaults to :data:None).
| Type | Description |
| ValueError | for invalid value types. |
modified
Union[datetime.datetime, None]: Datetime at which the dataset was
last modified (:data:None until set from the server).
path
str: URL path for the dataset based on project and dataset ID.
project
str: Project ID of the project bound to the dataset.
reference
google.cloud.bigquery.dataset.DatasetReference: A reference to this dataset.
self_link
Union[str, None]: URL for the dataset resource (:data:None until
set from the server).
Methods
from_api_repr
from_api_repr(resource)Factory: construct a dataset given its API representation
| Type | Description |
| google.cloud.bigquery.dataset.Dataset | Dataset parsed from ``resource``. |
from_string
from_string(full_dataset_id)Construct a dataset from fully-qualified dataset ID.
| Name | Description |
| full_dataset_id |
str
A fully-qualified dataset ID in standard SQL format. Must include both the project ID and the dataset ID, separated by |
| Type | Description |
| ValueError | If ``full_dataset_id`` is not a fully-qualified dataset ID in standard SQL format. |
| Type | Description |
| Dataset .. rubric:: Examples >>> Dataset.from_string('my-project-id.some_dataset') Dataset(DatasetReference('my-project-id', 'some_dataset')) | Dataset parsed from ``full_dataset_id``. |
model
model(model_id)Constructs a ModelReference.
| Name | Description |
| model_id |
str
the ID of the model. |
| Type | Description |
| google.cloud.bigquery.model.ModelReference | A ModelReference for a model in this dataset. |
routine
routine(routine_id)Constructs a RoutineReference.
| Name | Description |
| routine_id |
str
the ID of the routine. |
| Type | Description |
| google.cloud.bigquery.routine.RoutineReference | A RoutineReference for a routine in this dataset. |
table
table(table_id)Constructs a TableReference.
| Name | Description |
| table_id |
str
The ID of the table. |
| Type | Description |
| google.cloud.bigquery.table.TableReference | A table reference for a table in this dataset. |
to_api_repr
to_api_repr()Construct the API resource representation of this dataset
| Type | Description |
| Dict[str, object] | The dataset represented as an API resource |
__init__
__init__(dataset_ref)Initialize self. See help(type(self)) for accurate signature.