Struct tikv_kv::cursor::CursorBuilder

pub struct CursorBuilder<'a, S: Snapshot> {
    snapshot: &'a S,
    cf: CfName,
    scan_mode: ScanMode,
    fill_cache: bool,
    prefix_seek: bool,
    upper_bound: Option<Key>,
    lower_bound: Option<Key>,
    hint_min_ts: Option<TimeStamp>,
    hint_max_ts: Option<TimeStamp>,
    key_only: bool,
    max_skippable_internal_keys: u64,
}

A handy utility to build a snapshot cursor according to various configurations.

Fields

snapshot: &'a S

cf: CfName

scan_mode: ScanMode

fill_cache: bool

prefix_seek: bool

upper_bound: Option<Key>

lower_bound: Option<Key>

hint_min_ts: Option<TimeStamp>

hint_max_ts: Option<TimeStamp>

key_only: bool

max_skippable_internal_keys: u64

Implementations

impl<'a, S: 'a + Snapshot> CursorBuilder<'a, S>

pub fn new(snapshot: &'a S, cf: CfName) -> Self

Initialize a new CursorBuilder.

pub fn fill_cache(self, fill_cache: bool) -> Self

Set whether or not read operations should fill the cache.

Defaults to true.

pub fn prefix_seek(self, prefix_seek: bool) -> Self

Set whether or not to use prefix seek.

Defaults to false, it means use total order seek.

pub fn scan_mode(self, scan_mode: ScanMode) -> Self

Set iterator scanning mode.

Defaults to ScanMode::Forward.

pub fn range(self, lower: Option<Key>, upper: Option<Key>) -> Self

Set iterator range by giving lower and upper bound. The range is left closed right open.

Both default to None.

pub fn hint_min_ts(self, min_ts: Option<TimeStamp>) -> Self

Set the hint for the minimum commit ts we want to scan.

Default is empty.

pub fn hint_max_ts(self, max_ts: Option<TimeStamp>) -> Self

Set the hint for the maximum commit ts we want to scan.

Default is empty.

pub fn key_only(self, key_only: bool) -> Self

pub fn max_skippable_internal_keys(self, count: u64) -> Self

pub fn build(self) -> Result<Cursor<S::Iter>>

Build Cursor from the current configuration.