google.cloud.bigquery.table.TimePartitioning#
Methods
|
Return a |
Return a dictionary representing this object. |
Attributes
Number of milliseconds to keep the storage for a partition. |
|
Field in the table to use for partitioning |
|
Specifies whether partition filters are required for queries |
|
The type of time partitioning to use. |
-
class
google.cloud.bigquery.table.
TimePartitioning
(type_=None, field=None, expiration_ms=None, require_partition_filter=None)[source]# Bases:
object
Configures time-based partitioning for a table.
- Parameters
type_ (google.cloud.bigquery.table.TimePartitioningType, optional) – Specifies the type of time partitioning to perform. Defaults to
DAY
, which is the only currently supported type.field (str, optional) – 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-levelTIMESTAMP
orDATE
field. Its mode must beNULLABLE
orREQUIRED
.expiration_ms (int, optional) – Number of milliseconds for which to keep the storage for a partition.
require_partition_filter (bool, optional) – If set to true, queries over the partitioned table require a partition filter that can be used for partition elimination to be specified.
-
classmethod
from_api_repr
(api_repr)[source]# Return a
TimePartitioning
object deserialized from a dict.This method creates a new
TimePartitioning
instance that points to theapi_repr
parameter as its internal properties dict. This means that when aTimePartitioning
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'
- Parameters
api_repr (Mapping[str, str]) – The serialized representation of the TimePartitioning, such as what is output by
to_api_repr()
.- Returns
The
TimePartitioning
object.- Return type
-
property
require_partition_filter
# Specifies whether partition filters are required for queries
- Type
-
to_api_repr
()[source]# 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 aTimePartitioning
instance is stored as a property of another object, any changes made at the higher level will also appear here.- Returns
A dictionary representing the TimePartitioning object in serialized form.
- Return type
-
property
type_
# The type of time partitioning to use.