Module table (3.27.0)

Define API Tables.

Classes

CloneDefinition

CloneDefinition(resource: typing.Dict[str, typing.Any])

Information about base table and clone time of the clone.

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

ColumnReference

ColumnReference(referencing_column: str, referenced_column: str)

The pair of the foreign key column and primary key column.

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.

PartitionRange

PartitionRange(start=None, end=None, interval=None, _properties=None)

Definition of the ranges for range partitioning.

Parameters
Name Description
start Optional[int]

Sets the start property.
end Optional[int]

Sets the end property.
interval Optional[int]

Sets the interval 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.

RangePartitioning

RangePartitioning(range_=None, field=None, _properties=None)

Range-based partitioning configuration for a table.

Parameters
Name Description
range_ Optional[google.cloud.bigquery.table.PartitionRange]

Sets the range_ property.
field Optional[str]

Sets the field 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-None, except for subclasses that do not use it, namely the _EmptyRowIterator.
api_request Callable[google.cloud._http.JSONConnection.api_request]

The function to use to make API requests.
path str

The 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 with from_api_repr.
page_token str

A 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.

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

StreamingBuffer

StreamingBuffer(resource)

Information about a table's streaming buffer.

See https://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.

See https://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 table_ref is a string, it must included a project ID, dataset ID, and table ID, each separated by ..
schema Optional[Sequence[Union[ SchemaField, Mapping[str, Any] ]]]

The table's schema. If any item is a mapping, its content must be compatible with from_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.

TableListItem

TableListItem(resource)

A read-only table resource from a list operation.

For performance reasons, the BigQuery API only includes some of the table properties when listing tables. Notably, xref_schema and xref_num_rows are missing.

For a full list of the properties that the BigQuery API returns, see the REST 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 tableReference property is required.
Exceptions
Type Description
ValueError If tableReference or one of its required members is missing from resource.

TableReference

TableReference(dataset_ref: DatasetReference, table_id: str)

TableReferences are pointers to tables.

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

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 to DAY. 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 PARTITIONTIME. The field must be a top-level TIMESTAMP, DATETIME, or DATE field. Its mode must be NULLABLE or REQUIRED. See the time-unit column-partitioned tables guide https://cloud.google.com/bigquery/docs/creating-column-partitions in the BigQuery documentation.
expiration_ms Optional[int]

Number of milliseconds for which to keep the storage for a partition.
require_partition_filter Optional[bool]

DEPRECATED: Use require_partition_filter, instead.

TimePartitioningType

TimePartitioningType()

Specifies the type of time partitioning to perform.