Class DatasetReference (3.3.5)

Version 3.3.5

• 3.27.0 (latest)
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.1
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0

DatasetReference(project, dataset_id)

DatasetReferences are pointers to datasets.

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

Parameters

Name	Description
project	str The ID of the project
dataset_id	str The ID of the dataset

Inheritance

builtins.object > DatasetReference

Properties

dataset_id

str: Dataset ID.

path

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

project

str: Project ID of the dataset.

Methods

from_api_repr

from_api_repr(resource: dict)

Factory: construct a dataset reference given its API representation

Parameter

Name	Description
resource	Dict[str, str] Dataset reference resource representation returned from the API

Returns

Type	Description
google.cloud.bigquery.dataset.DatasetReference	Dataset reference parsed from resource.

from_string

from_string(dataset_id: str, default_project: Optional[str] = None)

Construct a dataset reference from dataset ID string.

Parameters

Name	Description
dataset_id	str A dataset ID in standard SQL format. If default_project is not specified, this must include both the project ID and the dataset ID, separated by ..
default_project	Optional[str] The project ID to use when dataset_id does not include a project ID.

Exceptions

Type	Description
ValueError	If dataset_id is not a fully-qualified dataset ID in standard SQL format.

Returns

Type	Description
DatasetReference .. rubric:: Examples >>> DatasetReference.from_string('my-project-id.some_dataset') DatasetReference('my-project-id', 'some_dataset')	Dataset reference parsed from dataset_id.

model

model(model_id)

Constructs a ModelReference.

Parameter

Name	Description
model_id	str the ID of the model.

Returns

Type	Description
google.cloud.bigquery.model.ModelReference	A ModelReference for a model in this dataset.

routine

routine(routine_id)

Constructs a RoutineReference.

Parameter

Name	Description
routine_id	str the ID of the routine.

Returns

Type	Description
google.cloud.bigquery.routine.RoutineReference	A RoutineReference for a routine in this dataset.

table

table(table_id: str)

Constructs a TableReference.

Parameter

Name	Description
table_id	str The ID of the table.

Returns

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 reference

Returns

Type	Description
Dict[str, str]	dataset reference represented as an API resource

__init__

__init__(project, dataset_id)

Initialize self. See help(type(self)) for accurate signature.

DatasetReference

DatasetReference(project, dataset_id)

DatasetReferences are pointers to datasets.

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

Parameters

Name	Description
project	str The ID of the project
dataset_id	str The ID of the dataset

Exceptions

Type	Description
ValueError	If either argument is not of type str.