org.apache.gravitino.rel

Interface SupportsPartitions

@Evolving
public interface SupportsPartitions

Interface for tables that support partitions.

Method Summary

Modifier and Type	Method and Description
Partition	addPartition(Partition partition) Add a partition with specified name and properties to the table.
boolean	dropPartition(java.lang.String partitionName) Drop a partition with specified name.
Partition	getPartition(java.lang.String partitionName) Get a partition by partition name, you may get one of the following types of partitions: IdentityPartition ListPartition RangePartition It depends on the Table.partitioning().
java.lang.String[]	listPartitionNames() List all partition names of the table
Partition[]	listPartitions() List all partitions
default boolean	partitionExists(java.lang.String partitionName) Check if a partition exists.
default boolean	purgePartition(java.lang.String partitionName) If the table supports purging, drop a partition with specified name and completely remove partition data by skipping a trash.

Method Detail

listPartitionNames

java.lang.String[] listPartitionNames()

List all partition names of the table

Returns:

The list of partition names

listPartitions

Partition[] listPartitions()

List all partitions

Returns:

The list of partitions

getPartition

Partition getPartition(java.lang.String partitionName)
                throws NoSuchPartitionException

Get a partition by partition name, you may get one of the following types of partitions:

• IdentityPartition
• ListPartition
• RangePartition

It depends on the Table.partitioning(). A Java type conversion is required before getting the specific partition, for example:

   RangePartition rangePartition = (RangePartition) table.supportPartitions().getPartition("p20200321");
   Literal<?> upper = rangePartition.upper();
   Literal<?> lower = rangePartition.lower();
   ...
 

Parameters:

partitionName - the name of the partition

Returns:

the partition

Throws:

NoSuchPartitionException - if the partition does not exist

partitionExists

default boolean partitionExists(java.lang.String partitionName)

Check if a partition exists.

Parameters:

partitionName - The name of the partition.

Returns:

True if the partition exists, false otherwise.

addPartition

Partition addPartition(Partition partition)
                throws PartitionAlreadyExistsException

Add a partition with specified name and properties to the table.

Parameters:

partition - The partition to add.

Returns:

The created partition.

Throws:

PartitionAlreadyExistsException - If the partition already exists.

dropPartition

boolean dropPartition(java.lang.String partitionName)

Drop a partition with specified name.

Parameters:

partitionName - the name of the partition

Returns:

true if the partition is deleted successfully, false if the partition does not exist.

purgePartition

default boolean purgePartition(java.lang.String partitionName)
                        throws java.lang.UnsupportedOperationException

If the table supports purging, drop a partition with specified name and completely remove partition data by skipping a trash. If the table is an external table or does not support purging partitions, UnsupportedOperationException is thrown.

Parameters:

partitionName - The name of the partition.

Returns:

true if the partition is purged, false if the partition does not exist.

Throws:

java.lang.UnsupportedOperationException - If partition purging is not supported.