Class TableReference (3.25.0)

Version latest

• 3.25.0 (latest)
• 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

TableReference(dataset_ref: DatasetReference, table_id: str)

TableReferences are pointers to tables.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablereference

Parameter
Name	Description
table_id	str The ID of the table

Properties

dataset_id

ID of dataset containing the table.

path

URL path for the table's APIs.

project

Project bound to the table.

table_id

The table ID.

Methods

from_api_repr

from_api_repr(resource: dict) -> google.cloud.bigquery.table.TableReference

Factory: construct a table reference given its API representation

Parameter
Name	Description
resource	Dict[str, object] Table reference representation returned from the API

Returns
Type	Description
google.cloud.bigquery.table.TableReference	Table reference parsed from resource.

from_string

from_string(
    table_id: str, default_project: typing.Optional[str] = None
) -> google.cloud.bigquery.table.TableReference

Construct a table reference from table ID string.

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

Exceptions
Type	Description
ValueError	If table_id is not a fully-qualified table ID in standard SQL format.

Returns
Type	Description
TableReference .. rubric:: Examples >>> TableReference.from_string('my-project.mydataset.mytable') TableRef...(DatasetRef...('my-project', 'mydataset'), 'mytable')	Table reference parsed from table_id.

to_api_repr

to_api_repr() -> dict

Construct the API resource representation of this table reference.

Returns
Type	Description
Dict[str, object]	Table reference represented as an API resource

to_bqstorage

to_bqstorage() -> str

Construct a BigQuery Storage API representation of this table.

Install the google-cloud-bigquery-storage package to use this feature.

If the table_id contains a partition identifier (e.g. my_table$201812) or a snapshot identifier (e.g. mytable@1234567890), it is ignored. Use xref_TableReadOptions to filter rows by partition. Use xref_TableModifiers to select a specific snapshot to read from.

Returns
Type	Description
str	A reference to this table in the BigQuery Storage API.