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
Count()
COUNT will return count of items selected.
public
static Count() : MapReturnType
Return values
MapReturnTypeExists()
EXISTS returns true if count > 0.
public
static Exists() : MapReturnType
Return values
MapReturnTypeIndex()
INDEX will return key index order.
public
static Index() : MapReturnType
0 = first key N = Nth key -1 = last key
Return values
MapReturnTypeInverted()
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
MapReturnTypeKey()
KEY will return key for single key read and key list for range read.
public
static Key() : MapReturnType
Return values
MapReturnTypeKeyValue()
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
MapReturnTypeNone()
NONE will will not return a result.
public
static None() : MapReturnType
Return values
MapReturnTypeOrderedMap()
ORDERED_MAP returns an ordered map.
public
static OrderedMap() : MapReturnType
Return values
MapReturnTypeRank()
RANK will return value order.
public
static Rank() : MapReturnType
0 = smallest value N = Nth smallest value -1 = largest value
Return values
MapReturnTypeReverseIndex()
REVERSE_INDEX will return reverse key order.
public
static ReverseIndex() : MapReturnType
0 = last key -1 = first key
Return values
MapReturnTypeReverseRank()
REVERSE_RANK will return reverse value order.
public
static ReverseRank() : MapReturnType
0 = largest value N = Nth largest value -1 = smallest value
Return values
MapReturnTypeUnorderedMap()
UNORDERED_MAP returns an unordered map.
public
static UnorderedMap() : MapReturnType
Return values
MapReturnTypeValue()
VALUE will return value for single key read and value list for range read.
public
static Value() : MapReturnType