Class TimePartitioning

public abstract class TimePartitioning implements Serializable

Objects of this class allow to configure table partitioning based on time. By dividing a large table into smaller partitions, you can improve query performance and reduce the number of bytes billed by restricting the amount of data scanned.

Inheritance

java.lang.Object > TimePartitioning

Implements

Serializable

Methods

getExpirationMs()

public abstract Long getExpirationMs()

Returns the number of milliseconds for which to keep the storage for a partition. When expired, the storage for the partition is reclaimed. If null, the partion does not expire.

Returns
TypeDescription
Long

getField()

public abstract String getField()

If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field.

Returns
TypeDescription
String

getRequirePartitionFilter()

public abstract Boolean getRequirePartitionFilter()

If set to true, queries over this table require a partition filter (that can be used for partition elimination) to be specified.

Returns
TypeDescription
Boolean

getType()

public abstract TimePartitioning.Type getType()

Returns the time partitioning type.

Returns
TypeDescription
TimePartitioning.Type

newBuilder(TimePartitioning.Type type)

public static TimePartitioning.Builder newBuilder(TimePartitioning.Type type)

Returns a TimePartitioning object given the time partitioning type.

Parameter
NameDescription
typeTimePartitioning.Type
Returns
TypeDescription
TimePartitioning.Builder

of(TimePartitioning.Type type)

public static TimePartitioning of(TimePartitioning.Type type)

Returns a TimePartitioning object given the time partitioning type. The partitions will not expire.

Parameter
NameDescription
typeTimePartitioning.Type
Returns
TypeDescription
TimePartitioning

of(TimePartitioning.Type type, long expirationMs)

public static TimePartitioning of(TimePartitioning.Type type, long expirationMs)

Returns a TimePartitioning object given the time partitioning type and the partition's expiration in milliseconds.

Parameters
NameDescription
typeTimePartitioning.Type

the time partitioning type.

expirationMslong

the number of milliseconds for which to keep the storage for a partition

Returns
TypeDescription
TimePartitioning

toBuilder()

public abstract TimePartitioning.Builder toBuilder()
Returns
TypeDescription
TimePartitioning.Builder