Class TimePartitioning (3.3.6)

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.

Inheritance

builtins.object > TimePartitioning

Properties

expiration_ms

int: Number of milliseconds to keep the storage for a partition.

field

str: Field in the table to use for partitioning

require_partition_filter

bool: Specifies whether partition filters are required for queries

DEPRECATED: Use require_partition_filter, instead.

type_

google.cloud.bigquery.table.TimePartitioningType: The type of time partitioning to use.

Methods

from_api_repr

from_api_repr(api_repr: dict)

Return a TimePartitioning object deserialized from a dict.

This method creates a new TimePartitioning instance that points to the api_repr parameter as its internal properties dict. This means that when a TimePartitioning instance is stored as a property of another object, any changes made at the higher level will also appear here::

>>> time_partitioning = TimePartitioning()
>>> table.time_partitioning = time_partitioning
>>> table.time_partitioning.field = 'timecolumn'
>>> time_partitioning.field
'timecolumn'

Parameter

Name	Description
api_repr	`Mapping[str, str]` The serialized representation of the TimePartitioning, such as what is output by `to_api_repr`.

Returns

Type	Description
google.cloud.bigquery.table.TimePartitioning	The `TimePartitioning` object.

to_api_repr

to_api_repr()

Return a dictionary representing this object.

This method returns the properties dict of the TimePartitioning instance rather than making a copy. This means that when a TimePartitioning instance is stored as a property of another object, any changes made at the higher level will also appear here.

Returns

Type	Description
dict	A dictionary representing the TimePartitioning object in serialized form.

init

__init__(type_=None, field=None, expiration_ms=None, require_partition_filter=None)

Initialize self. See help(type(self)) for accurate signature.

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.