google.cloud.bigquery.table.Table#

Methods

from_api_repr(resource) Factory: construct a table given its API representation
from_string(full_table_id) Construct a table from fully-qualified table ID.
to_api_repr() Constructs the API resource of this table
to_bqstorage() Construct a BigQuery Storage API representation of this table.

Attributes

clustering_fields Fields defining clustering for the table
created Datetime at which the table was created (None until set from the server).
dataset_id ID of dataset containing the table.
description Description of the table (defaults to None).
encryption_configuration Custom encryption configuration for the table.
etag ETag for the table resource (None until set from the server).
expires Datetime at which the table will be deleted.
external_data_configuration Configuration for an external data source (defaults to None).
friendly_name Title of the table (defaults to None).
full_table_id ID for the table (None until set from the server).
labels Labels for the table.
location Location in which the table is hosted
modified Datetime at which the table was last modified (None until set from the server).
num_bytes The size of the table in bytes (None until set from the server).
num_rows The number of rows in the table (None until set from the server).
partition_expiration Expiration time in milliseconds for a partition.
partitioning_type Time partitioning of the table if it is partitioned (Defaults to None).
path URL path for the table’s APIs.
project Project bound to the table.
reference A TableReference pointing to this table.
schema Table’s schema.
self_link URL for the table resource (None until set from the server).
streaming_buffer Information about a table’s streaming buffer.
table_id ID of the table.
table_type The type of the table (None until set from the server).
time_partitioning Configures time-based partitioning for a table.
view_query SQL query defining the table as a view (defaults to None).
view_use_legacy_sql Specifies whether to execute the view with Legacy or Standard SQL.


class google.cloud.bigquery.table.Table(table_ref, schema=None)[source]#

Bases: object

Tables represent a set of rows whose values correspond to a schema.

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

Parameters:
clustering_fields#

Fields defining clustering for the table

(Defaults to None).

Clustering fields are immutable after table creation.

Note

As of 2018-06-29, clustering fields cannot be set on a table which does not also have time partioning defined.

Type:Union[List[str], None]
created#

Datetime at which the table was created (None until set from the server).

Type:Union[datetime.datetime, None]
dataset_id#

ID of dataset containing the table.

Type:str
description#

Description of the table (defaults to None).

Raises:ValueError – For invalid value types.
Type:Union[str, None]
encryption_configuration#

Custom encryption configuration for the table.

Custom encryption configuration (e.g., Cloud KMS keys) or None if using default encryption.

See protecting data with Cloud KMS keys in the BigQuery documentation.

Type:google.cloud.bigquery.table.EncryptionConfiguration
etag#

ETag for the table resource (None until set from the server).

Type:Union[str, None]
expires#

Datetime at which the table will be deleted.

Raises:ValueError – For invalid value types.
Type:Union[datetime.datetime, None]
external_data_configuration#

Configuration for an external data source (defaults to None).

Raises:ValueError – For invalid value types.
Type:Union[google.cloud.bigquery.ExternalConfig, None]
friendly_name#

Title of the table (defaults to None).

Raises:ValueError – For invalid value types.
Type:Union[str, None]
classmethod from_api_repr(resource)[source]#

Factory: construct a table given its API representation

Parameters:resource (Dict[str, object]) – Table resource representation from the API
Returns:Table parsed from resource.
Return type:google.cloud.bigquery.table.Table
Raises:KeyError – If the resource lacks the key 'tableReference', or if the dict stored within the key 'tableReference' lacks the keys 'tableId', 'projectId', or 'datasetId'.
classmethod from_string(full_table_id)[source]#

Construct a table from fully-qualified table ID.

Parameters:full_table_id (str) – A fully-qualified table ID in standard SQL format. Must included a project ID, dataset ID, and table ID, each separated by ..
Returns:Table parsed from full_table_id.
Return type:Table

Examples

>>> Table.from_string('my-project.mydataset.mytable')
Table(TableRef...(D...('my-project', 'mydataset'), 'mytable'))
Raises:ValueError – If full_table_id is not a fully-qualified table ID in standard SQL format.
full_table_id#

ID for the table (None until set from the server).

In the format project_id:dataset_id.table_id.

Type:Union[str, None]
labels#

Labels for the table.

This method always returns a dict. To change a table’s labels, modify the dict, then call Client.update_table. To delete a label, set its value to None before updating.

Raises:ValueError – If value type is invalid.
Type:Dict[str, str]
location#

Location in which the table is hosted

Defaults to None.

Type:Union[str, None]
modified#

Datetime at which the table was last modified (None until set from the server).

Type:Union[datetime.datetime, None]
num_bytes#

The size of the table in bytes (None until set from the server).

Type:Union[int, None]
num_rows#

The number of rows in the table (None until set from the server).

Type:Union[int, None]
partition_expiration#

Expiration time in milliseconds for a partition.

If partition_expiration is set and type_ is not set, type_ will default to DAY.

Type:Union[int, None]
partitioning_type#

Time partitioning of the table if it is partitioned (Defaults to None).

The only partitioning type that is currently supported is DAY.

Type:Union[str, None]
path#

URL path for the table’s APIs.

Type:str
project#

Project bound to the table.

Type:str
reference#

A TableReference pointing to this table.

Returns:pointer to this table.
Return type:google.cloud.bigquery.table.TableReference
schema#

Table’s schema.

Raises:
Type:

List[google.cloud.bigquery.schema.SchemaField]

URL for the table resource (None until set from the server).

Type:Union[str, None]
streaming_buffer#

Information about a table’s streaming buffer.

Type:google.cloud.bigquery.StreamingBuffer
table_id#

ID of the table.

Type:str
table_type#

The type of the table (None until set from the server).

Possible values are 'TABLE', 'VIEW', or 'EXTERNAL'.

Type:Union[str, None]
time_partitioning#

Configures time-based partitioning for a table.

Raises:ValueError – If the value is not TimePartitioning or None.
Type:google.cloud.bigquery.table.TimePartitioning
to_api_repr()[source]#

Constructs the API resource of this table

Returns:Table represented as an API resource
Return type:Dict[str, object]
to_bqstorage()[source]#

Construct a BigQuery Storage API representation of this table.

Returns:A reference to this table in the BigQuery Storage API.
Return type:google.cloud.bigquery_storage_v1beta1.types.TableReference
view_query#

SQL query defining the table as a view (defaults to None).

By default, the query is treated as Standard SQL. To use Legacy SQL, set view_use_legacy_sql to True.

Raises:ValueError – For invalid value types.
Type:Union[str, None]
view_use_legacy_sql#

Specifies whether to execute the view with Legacy or Standard SQL.

This boolean specifies whether to execute the view with Legacy SQL (True) or Standard SQL (False). The client side default is False. The server-side default is True. If this table is not a view, None is returned.

Raises:ValueError – For invalid value types.
Type:bool