Class TableReference (3.34.0) (original) (raw)
Class TableReference (3.34.0)
TableReference(dataset_ref: DatasetReference, table_id: str)Methods
from_api_repr
from_api_repr(resource: dict) -> google.cloud.bigquery.table.TableReferenceFactory: 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.TableReferenceConstruct 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
Construct the API resource representation of this table reference.
| Returns | |
|---|---|
| Type | Description |
| Dict[str, object] | Table reference represented as an API resource |
to_bqstorage
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. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-12 UTC.