Module table (3.20.1)
- 3.39.0 (latest)
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.27.0
- 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
Define API Tables.
Classes
CloneDefinition
CloneDefinition(resource:typing.Dict[str,typing.Any])Information about base table and clone time of the clone.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#clonedefinition
| Parameter | |
|---|---|
| Name | Description |
resource | typing.Dict[str, typing.Any]Clone definition representation returned from the API. |
ColumnReference
ColumnReference(referencing_column:str,referenced_column:str)The pair of the foreign key column and primary key column.
| Parameters | |
|---|---|
| Name | Description |
referencing_column | strThe column that composes the foreign key. |
referenced_column | strThe column in the primary key that are referenced by the referencingColumn. |
ForeignKey
ForeignKey(name:str,referenced_table:google.cloud.bigquery.table.TableReference,column_references:typing.List[google.cloud.bigquery.table.ColumnReference],)Represents a foreign key constraint on a table's columns.
| Parameters | |
|---|---|
| Name | Description |
name | strSet only if the foreign key constraint is named. |
referenced_table | TableReferenceThe table that holds the primary key and is referenced by this foreign key. |
column_references | typing.List[google.cloud.bigquery.table.ColumnReference]The columns that compose the foreign key. |
PartitionRange
PartitionRange(start=None,end=None,interval=None,_properties=None)Definition of the ranges for range partitioning.
Note:Beta. The integer range partitioning feature is in a pre-releasestate and might change or have limited support.| Parameters | |
|---|---|
| Name | Description |
start | Optional[int]Sets thestart property. |
end | Optional[int]Sets theend property. |
interval | Optional[int]Sets theinterval property. |
_properties | Optional[dict]Private. Used to construct object from API resource. |
PrimaryKey
PrimaryKey(columns:typing.List[str])Represents the primary key constraint on a table's columns.
| Parameter | |
|---|---|
| Name | Description |
columns | typing.List[str]The columns that are composed of the primary key constraint. |
RangePartitioning
RangePartitioning(range_=None,field=None,_properties=None)Range-based partitioning configuration for a table.
Note:Beta. The integer range partitioning feature is in a pre-releasestate and might change or have limited support.| Parameters | |
|---|---|
| Name | Description |
range_ | Optional[google.cloud.bigquery.table.PartitionRange]Sets therange_ property. |
field | Optional[str]Sets thefield property. |
_properties | Optional[dict]Private. Used to construct object from API resource. |
Row
Row(values,field_to_index)A BigQuery row.
Values can be accessed by position (index), by key like a dict,or as properties.
| Parameters | |
|---|---|
| Name | Description |
values | Sequence[object]The row values |
field_to_index | Dict[str, int]A mapping from schema field names to indexes |
RowIterator
RowIterator(client,api_request,path,schema,page_token=None,max_results=None,page_size=None,extra_params=None,table=None,selected_fields=None,total_rows=None,first_page_response=None,location:typing.Optional[str]=None,job_id:typing.Optional[str]=None,query_id:typing.Optional[str]=None,project:typing.Optional[str]=None,num_dml_affected_rows:typing.Optional[int]=None,)A class for iterating through HTTP/JSON API row list responses.
| Parameters | |
|---|---|
| Name | Description |
client | Optional[google.cloud.bigquery.Client]The API client instance. This should always be non- |
api_request | Callable[google.cloud._http.JSONConnection.api_request]The function to use to make API requests. |
path | strThe method path to query for the list of items. |
schema | Sequence[Union[SchemaField, Mapping[str, Any] ]]The table's schema. If any item is a mapping, its content must be compatible withfrom_api_repr. |
page_token | strA token identifying a page in a result set to start fetching results from. |
max_results | Optional[int]The maximum number of results to fetch. |
page_size | Optional[int]The maximum number of rows in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API. |
extra_params | Optional[Dict[str, object]]Extra query string parameters for the API call. |
table | Optional[Union[google.cloud.bigquery.table.Table,google.cloud.bigquery.table.TableReference, ]]The table which these rows belong to, or a reference to it. Used to call the BigQuery Storage API to fetch rows. |
selected_fields | Optional[Sequence[google.cloud.bigquery.schema.SchemaField]]A subset of columns to select from this table. |
total_rows | Optional[int]Total number of rows in the table. |
first_page_response | Optional[dict]API response for the first page of results. These are returned when the first page is requested. |
SnapshotDefinition
SnapshotDefinition(resource:typing.Dict[str,typing.Any])Information about base table and snapshot time of the snapshot.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#snapshotdefinition
| Parameter | |
|---|---|
| Name | Description |
resource | typing.Dict[str, typing.Any]Snapshot definition representation returned from the API. |
StreamingBuffer
StreamingBuffer(resource)Information about a table's streaming buffer.
Seehttps://cloud.google.com/bigquery/streaming-data-into-bigquery.
| Parameter | |
|---|---|
| Name | Description |
resource | Dict[str, object]streaming buffer representation returned from the API |
Table
Table(table_ref,schema=None)Tables represent a set of rows whose values correspond to a schema.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource-table
| Parameters | |
|---|---|
| Name | Description |
table_ref | Union[google.cloud.bigquery.table.TableReference, str]A pointer to a table. If |
schema | Optional[Sequence[Union[SchemaField, Mapping[str, Any] ]]]The table's schema. If any item is a mapping, its content must be compatible withfrom_api_repr. |
TableConstraints
TableConstraints(primary_key:typing.Optional[google.cloud.bigquery.table.PrimaryKey],foreign_keys:typing.Optional[typing.List[google.cloud.bigquery.table.ForeignKey]],)The TableConstraints defines the primary key and foreign key.
| Parameters | |
|---|---|
| Name | Description |
primary_key | typing.Optional[google.cloud.bigquery.table.PrimaryKey]Represents a primary key constraint on a table's columns. Present only if the table has a primary key. The primary key is not enforced. |
foreign_keys | typing.Optional[typing.List[google.cloud.bigquery.table.ForeignKey]]Present only if the table has a foreign key. The foreign key is not enforced. |
TableListItem
TableListItem(resource)A read-only table resource from a list operation.
For performance reasons, the BigQuery API only includes some of the tableproperties when listing tables. Notably,xref_schema andxref_num_rows are missing.
For a full list of the properties that the BigQuery API returns, see theREST documentation for tables.list<https://cloud.google.com/bigquery/docs/reference/rest/v2/tables/list>_.
| Parameter | |
|---|---|
| Name | Description |
resource | Dict[str, object]A table-like resource object from a table list response. A |
| Exceptions | |
|---|---|
| Type | Description |
ValueError | IftableReference or one of its required members is missing fromresource. |
TableReference
TableReference(dataset_ref:DatasetReference,table_id:str)TableReferences are pointers to tables.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablereference
| Parameter | |
|---|---|
| Name | Description |
table_id | strThe ID of the table |
TimePartitioning
TimePartitioning(type_=None,field=None,expiration_ms=None,require_partition_filter=None)Configures time-based partitioning for a table.
| Parameters | |
|---|---|
| Name | Description |
type_ | Optional[google.cloud.bigquery.table.TimePartitioningType]Specifies the type of time partitioning to perform. Defaults toDAY. Supported values are: *HOUR *DAY *MONTH *YEAR |
field | Optional[str]If set, the table is partitioned by this field. If not set, the table is partitioned by pseudo column |
expiration_ms | Optional[int]Number of milliseconds for which to keep the storage for a partition. |
require_partition_filter | Optional[bool]DEPRECATED: Userequire_partition_filter, instead. |
TimePartitioningType
TimePartitioningType()Specifies the type of time partitioning to perform.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-16 UTC.