Apache Geode Native C++ Reference 1.15.0
apache::geode::client::PartitionResolver Class Referenceabstract

Implement the PartitionResolver interface to enable custom partitioning on the PartitionedRegion. More...

#include <PartitionResolver.hpp>

Inherited by apache::geode::client::FixedPartitionResolver, and apache::geode::client::StringPrefixPartitionResolver.

Public Member Functions

virtual const std::string & getName ()
 Returns the name of the PartitionResolver. More...
virtual std::shared_ptr< CacheableKeygetRoutingObject (const EntryEvent &opDetails)=0
virtual ~PartitionResolver ()
 public methods More...

Protected Member Functions

 PartitionResolver ()
 constructors More...

Detailed Description

Implement the PartitionResolver interface to enable custom partitioning on the PartitionedRegion.

The Key class or callback arg can implement the PartitionResolver interface to enable custom partitioning, or you can configure your own PartitionResolver class in partition attributes (for instance when the Key is a primitive type or String):

  • Implement the appropriate equals. For all implementations, you need to be sure to code the class equals method so it properly verifies equality for the PartitionResolver implementation. This might mean verifying that class names are the same or that the returned routing objects are the same etc. When you initiate the partitioned region on multiple nodes, Geode uses the equals method to ensure you are using the same PartitionResolver implementation for all of the nodes for the region.
  • Geode uses the routing object's hashCode to determine where the data is being managed. Say, for example, you want to colocate all Trades by month and year. The key is implemented by a TradeKey class which also implements the PartitionResolver interface:
public class TradeKey implements PartitionResolver {
private String tradeID;
private Month month;
private Year year;
public TradingKey() { }
public TradingKey(Month month, Year year) {
this.month = month;
this.year = year;
public Serializable getRoutingObject(EntryOperation opDetails) {
return this.month + this.year;
virtual std::shared_ptr< CacheableKey > getRoutingObject(const EntryEvent &opDetails)=0

In the example above, all trade entries with the same month and year are guaranteed to be colocated.

Constructor & Destructor Documentation

◆ ~PartitionResolver()

virtual apache::geode::client::PartitionResolver::~PartitionResolver ( )

public methods


◆ PartitionResolver()

apache::geode::client::PartitionResolver::PartitionResolver ( )


Member Function Documentation

◆ getName()

virtual const std::string & apache::geode::client::PartitionResolver::getName ( )

Returns the name of the PartitionResolver.

String name

Reimplemented in apache::geode::client::StringPrefixPartitionResolver.

◆ getRoutingObject()

virtual std::shared_ptr< CacheableKey > apache::geode::client::PartitionResolver::getRoutingObject ( const EntryEvent opDetails)
pure virtual
opDetailsthe detail of the entry event
RuntimeException- any exception thrown will terminate the operation and the exception will be passed to the calling thread.
object associated with entry event which allows the Partitioned Region to store associated data together

Implemented in apache::geode::client::StringPrefixPartitionResolver.

Apache Geode C++ Cache API Documentation