- 3.25.0 (latest)
- 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
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 |
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 > TimePartitioningProperties
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'
Name | Description |
api_repr |
Mapping[str, str]
The serialized representation of the TimePartitioning, such as what is output by |
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.
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.
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 |
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. |