Package com.apple.foundationdb.record.provider.foundationdb

Class FDBLocalityUtil

java.lang.Object

com.apple.foundationdb.record.provider.foundationdb.FDBLocalityUtil

All Implemented Interfaces:

FDBLocalityProvider

public class FDBLocalityUtil
extends Object
implements FDBLocalityProvider

An implementation of the FDBLocalityProvider interface that uses foundationDB's LocalityUtil API to discover the storage locations of keys within a cluster.

Method Summary

Modifier and Type	Method	Description
CloseableAsyncIterator<byte[]>	getBoundaryKeys(Transaction tr, byte[] begin, byte[] end)	Return an estimate of the keys boundaries within the given range.
static FDBLocalityUtil	instance()	Get the single instance of this utility class.

Methods inherited from class java.lang.Object

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

Method Detail

instance

@Nonnull
public static FDBLocalityUtil instance()

Get the single instance of this utility class.

Returns:

the only instance of the class

getBoundaryKeys

@Nonnull
public CloseableAsyncIterator<byte[]> getBoundaryKeys(@Nonnull
                                                      Transaction tr,
                                                      @Nonnull
                                                      byte[] begin,
                                                      @Nonnull
                                                      byte[] end)

Return an estimate of the keys boundaries within the given range.

The method results in a CloseableAsyncIterator of keys k such that begin <= k < end and k is located at the start of a contiguous range stored on a single server.

Specified by:

getBoundaryKeys in interface FDBLocalityProvider

Parameters:

tr - the transaction on which to base the query

begin - the inclusive start of the range

end - the exclusive end of the range

Returns:

a sequence of keys denoting the start of single-server ranges

See Also:

LocalityUtil.getBoundaryKeys(Transaction, byte[], byte[])