Documentation

MapReturnType
in package

MapReturnType defines the map return type.

Type of data to return when selecting or removing items from the map.

Table of Contents

Methods

Count()  : MapReturnType
COUNT will return count of items selected.
Exists()  : MapReturnType
EXISTS returns true if count > 0.
Index()  : MapReturnType
INDEX will return key index order.
Inverted()  : MapReturnType
INVERTED will invert meaning of map command and return values. For example: MapRemoveByKeyRange(binName, keyBegin, keyEnd, MapReturnType.KEY | MapReturnType.INVERTED) With the INVERTED flag enabled, the keys outside of the specified key range will be removed and returned.
Key()  : MapReturnType
KEY will return key for single key read and key list for range read.
KeyValue()  : MapReturnType
KEY_VALUE will return key/value items. The possible return types are:
None()  : MapReturnType
NONE will will not return a result.
OrderedMap()  : MapReturnType
ORDERED_MAP returns an ordered map.
Rank()  : MapReturnType
RANK will return value order.
ReverseIndex()  : MapReturnType
REVERSE_INDEX will return reverse key order.
ReverseRank()  : MapReturnType
REVERSE_RANK will return reverse value order.
UnorderedMap()  : MapReturnType
UNORDERED_MAP returns an unordered map.
Value()  : MapReturnType
VALUE will return value for single key read and value list for range read.

Methods

Inverted()

INVERTED will invert meaning of map command and return values. For example: MapRemoveByKeyRange(binName, keyBegin, keyEnd, MapReturnType.KEY | MapReturnType.INVERTED) With the INVERTED flag enabled, the keys outside of the specified key range will be removed and returned.

public Inverted() : MapReturnType
Return values
MapReturnType

KeyValue()

KEY_VALUE will return key/value items. The possible return types are:

public static KeyValue() : MapReturnType

map[interface}]interface} : Returned for unordered maps []MapPair : Returned for range results where range order needs to be preserved.

Return values
MapReturnType

        
On this page

Search results