kinetic-c  v0.12.0
Seagate Kinetic Protocol Client Library for C
Data Fields
KineticKeyRange Struct Reference

Kinetic Key Range request structure. More...

#include <kinetic_types.h>

Data Fields

ByteBuffer startKey
 Required bytes, the beginning of the requested range. More...
 
ByteBuffer endKey
 Required bytes, the end of the requested range. More...
 
bool startKeyInclusive
 Optional bool, defaults to false If set, indicates that the start key should be included in the returned range. More...
 
bool endKeyInclusive
 Optional bool, defaults to false If set, indicates that the end key should be included in the returned range. More...
 
int32_t maxReturned
 Required int32, must be greater than 0 The maximum number of keys returned, in sorted order. More...
 
bool reverse
 Optional bool, defaults to false If true, the key range will be returned in reverse order, starting at endKey and moving back to startKey. More...
 

Detailed Description

Kinetic Key Range request structure.

Definition at line 255 of file kinetic_types.h.

Field Documentation

ByteBuffer KineticKeyRange::startKey

Required bytes, the beginning of the requested range.

Definition at line 258 of file kinetic_types.h.

ByteBuffer KineticKeyRange::endKey

Required bytes, the end of the requested range.

Definition at line 261 of file kinetic_types.h.

bool KineticKeyRange::startKeyInclusive

Optional bool, defaults to false If set, indicates that the start key should be included in the returned range.

Definition at line 265 of file kinetic_types.h.

bool KineticKeyRange::endKeyInclusive

Optional bool, defaults to false If set, indicates that the end key should be included in the returned range.

Definition at line 269 of file kinetic_types.h.

int32_t KineticKeyRange::maxReturned

Required int32, must be greater than 0 The maximum number of keys returned, in sorted order.

Definition at line 273 of file kinetic_types.h.

bool KineticKeyRange::reverse

Optional bool, defaults to false If true, the key range will be returned in reverse order, starting at endKey and moving back to startKey.

For instance if the search is startKey="j", endKey="k", maxReturned=2, reverse=true and the keys "k0", "k1", "k2" exist the system will return "k2" and "k1" in that order.

Definition at line 281 of file kinetic_types.h.


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