Kudu C++ client API
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
kudu::client::KuduPartitionerBuilder Class Reference

Builder for Partitioner instances. More...

#include <client.h>

Public Member Functions

 KuduPartitionerBuilder (sp::shared_ptr< KuduTable > table)
 
KuduPartitionerBuilderSetBuildTimeout (MonoDelta timeout)
 
Status Build (KuduPartitioner **partitioner)
 

Detailed Description

Builder for Partitioner instances.

Constructor & Destructor Documentation

kudu::client::KuduPartitionerBuilder::KuduPartitionerBuilder ( sp::shared_ptr< KuduTable table)
explicit

Construct an instance of the class.

Parameters
[in]tableThe table whose rows should be partitioned.

Member Function Documentation

Status kudu::client::KuduPartitionerBuilder::Build ( KuduPartitioner **  partitioner)

Create a KuduPartitioner object for the specified table.

This fetches all of the partitioning information up front if it is not already cached by the associated KuduClient object. Thus, it may time out or have an error if the Kudu master is not accessible.

Parameters
[out]partitionerThe resulting KuduPartitioner instance; caller gets ownership.
Note
If the KuduClient object associated with the table already has some partition information cached (e.g. due to the construction of other Partitioners, or due to normal read/write activity), the resulting Partitioner will make use of that cached information. This means that the resulting partitioner is not guaranteed to have up-to-date partition information in the case that there has been a recent change to the partitioning of the target table.
Returns
Operation result status.
KuduPartitionerBuilder* kudu::client::KuduPartitionerBuilder::SetBuildTimeout ( MonoDelta  timeout)

Set the timeout used for building the Partitioner object.

Parameters
[in]timeoutThe timeout to set.
Returns
Pointer to the result object.

The documentation for this class was generated from the following file: