Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCBDB__FileCursor.html below:
NCBI C++ ToolKit: CBDB_FileCursor Class Reference
Search Toolkit Book for CBDB_FileCursor
Berkeley DB file cursor class. More...
#include <db/bdb/bdb_cursor.hpp>
Collaboration diagram for CBDB_FileCursor:
Public Types enum ECondition {
eNotSet , eFirst , eLast , eEQ ,
eGT , eGE , eLT , eLE
} enum EFetchDirection { eForward , eBackward , eCurrent , eDefault } enum ECursorUpdateType { eReadUpdate , eReadModifyUpdate } Type of locking when fetching records. More...
enum EMultiFetchMode { eFetchAll , eFetchGetBufferEnds } Fetch mode regulates multi-row fetches eFetchAll (default mode) when buffer ends, cursor automatically reads the next buffer eFetchGetBufferEnds - returns eBDB_MultiRowEnd every time cursor needs to read from disk. More...
typedef unsigned long TRecordCount Public Member Functions CBDB_FileCursor (CBDB_File &dbf, ECursorUpdateType utype=eReadUpdate) CBDB_FileCursor (CBDB_File &dbf, CBDB_Transaction &trans, ECursorUpdateType utype=eReadUpdate) ~CBDB_FileCursor () void InitMultiFetch (size_t buffer_size, EMultiFetchMode mfm=eFetchAll) Init multi-row fetch. More...
void SetCondition (ECondition cond_from, ECondition cond_to=eNotSet) Set search condition(type of interval) More...
void SetFetchDirection (EFetchDirection fdir) EFetchDirection GetFetchDirection () const EFetchDirection GetReverseFetchDirection () const void ReverseFetchDirection () EBDB_ErrCode FetchFirst () EBDB_ErrCode FetchFirst (void **buf, size_t buf_size, CBDB_RawFile::EReallocMode allow_realloc) Fetch BLOB. More...
EBDB_ErrCode FetchFirst (CBDB_RawFile::TBuffer *buf) Fetch BLOB. More...
EBDB_ErrCode Fetch (EFetchDirection fdir=eDefault) Fetch record. More...
EBDB_ErrCode Fetch (EFetchDirection fdir, void **buf, size_t buf_size, CBDB_RawFile::EReallocMode allow_realloc) Fetch BLOB. More...
EBDB_ErrCode Fetch (CBDB_RawFile::TBuffer *buf, EFetchDirection fdir=eDefault) Fetch BLOB. More...
EBDB_ErrCode Update (CBDB_File::EAfterWrite write_flag=CBDB_File::eDiscardData) EBDB_ErrCode Delete (CBDB_File::EIgnoreError on_error=CBDB_File::eThrowOnError) EBDB_ErrCode UpdateBlob (const void *data, size_t size, CBDB_File::EAfterWrite write_flag=CBDB_File::eDiscardData) const void * GetLastMultiFetchData () const Get data pointer from last fetch (only when in multifetch mode) More...
size_t GetLastMultiFetchDataLen () const Get data length from last fetch (only when in multifetch mode) More...
TRecordCount KeyDupCount () const CBDB_File & GetDBFile () Return database file on which cursor is based. More...
void Close () Close underlying cursor. More...
void ReOpen (CBDB_Transaction *trans) Reopen cursor after Close. More...
bool IsOpen () const TRUE when cursor open. More...
Detailed Description
Berkeley DB file cursor class.
BDB btree cursors can retrieve values using FROM-TO range criteria.
Definition at line 94 of file bdb_cursor.hpp.
The documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4