Class DatasetReference (2.11.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)

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, default_project=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)

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.