org.apache.kudu.client

Class KuduPartitioner

java.lang.Object

org.apache.kudu.client.KuduPartitioner

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class KuduPartitioner
extends Object

A KuduPartitioner allows clients to determine the target partition of a row without actually performing a write. The set of partitions is eagerly fetched when the KuduPartitioner is constructed so that the actual partitioning step can be performed synchronously without any network trips. NOTE: Because this operates on a metadata snapshot retrieved at construction time, it will not reflect any metadata changes to the table that have occurred since its creation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KuduPartitioner.KuduPartitionerBuilder A Builder class to build KuduPartitioner.

Constructor Summary

Constructors

Constructor and Description
KuduPartitioner(org.apache.kudu.client.PartitionSchema partitionSchema, Map<String,org.apache.kudu.client.Partition> tabletIdToPartition)

Method Summary

Modifier and Type	Method and Description
boolean	isCovered(PartialRow row) Determine if the given row falls into a valid partition.
int	numPartitions()
int	partitionRow(PartialRow row) Determine the partition index that the given row falls into.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KuduPartitioner

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public KuduPartitioner(org.apache.kudu.client.PartitionSchema partitionSchema,
                                                                                Map<String,org.apache.kudu.client.Partition> tabletIdToPartition)

Method Detail

numPartitions

public int numPartitions()

Returns:

the number of partitions known by this partitioner.

isCovered

public boolean isCovered(PartialRow row)

Determine if the given row falls into a valid partition. NOTE: The row must be constructed with a schema returned from the Kudu server. ex: `KuduTable.getSchema().newPartialRow();`

Parameters:

row - The row to check.

Returns:

true if the row falls into a valid partition.

partitionRow

public int partitionRow(PartialRow row)
                 throws org.apache.kudu.client.NonCoveredRangeException

Determine the partition index that the given row falls into. NOTE: The row must be constructed with a schema returned from the Kudu server. ex: `KuduTable.getSchema().newPartialRow();`

Parameters:

row - The row to be partitioned.

Returns:

The resulting partition index. The result will be less than numPartitions()

Throws:

org.apache.kudu.client.NonCoveredRangeException - if the row falls into a non-covered range.