bg

ScanFilter (Embedded)

chevron

ScanFilter Type

For BangDB Embedded

ScanFilter is used to set a few elements for scan. Note this is mainly used for the primary keys. For example if we wish to scan data like following;

Range : Key > "abc" and key < "bcde" [ using skey_op and ekey_op of ScanFilter respectively ] Limit : 100 (Limit By defines what) Limit By : data size | number of rows Only Key : true (only keys), false (both key and value) Reserved : There is reserved variable, used for certain cases
See below for detail API

C++

Selected

Java

Selected

To create scanFilter object

ScanFilter();
To set ScanOperator for skey
void set_skey_op(ScanOperator skey_op); ScanOperator is an enum with values GT, GTE, LT, LTE, EQ, NE Please see more on this at bangdb common
To get ScanOperator for skey
ScanOperator get_skey_op();
To set ScanOperator for ekey
void set_ekey_op(ScanOperator ekey_op); ScanOperator is an enum with values GT, GTE, LT, LTE, EQ, NE Please see more on this at bangdb common
To get ScanOperator for ekey
ScanOperator get_ekey_op();
To set ScanLimitBy
void set_limit_by(ScanLimitBy limitby); ScanLimitBy is an enum with values LIMIT_INVALID = -1 LIMIT_RESULT_SIZE, LIMIT_RESULT_ROW
To get the set ScanLimitBy value
ScanLimitBy get_limit_by();
To set limit
void set_limit(int limit);
To get the set limit value
int get_limit();
To set key flag
void set_only_key(short flag);
To get status of set key
short get_only_key();
To set reserved value
void set_reserved(int reserved);
To get the value of reserved set
int get_reserved();
To delete ScanFilter object
virtual ~ScanFilter();

public ScanOperator skeyOp;
To set ScanOperator for skey
public ScanOperator ekeyOp; ScanOperator is an enum with values GT, GTE, LT, LTE, EQ, NE Please see more on this at bangdb common
To set ScanLimitBy
public ScanLimitBy limitBy; ScanLimitBy is an enum with values LIMIT_INVALID = -1 LIMIT_RESULT_SIZE, LIMIT_RESULT_ROW
To set to limit
public int limit;
To set to skip count
public int skipCount;
To set key flag
public int onlyKey;
To get filter Query
public ScanFilter()
To set filter
public void setFilter()
To close scanfilter
public synchronized void close()