Struct tikv::storage::mvcc::ScannerBuilder

[+] Show declaration

pub struct ScannerBuilder<S: Snapshot>(ScannerConfig<S>);

Implementations

impl<S: Snapshot> ScannerBuilder<S>[−]

pub fn new(snapshot: S, ts: TimeStamp, desc: bool) -> Self[−]

Initialize a new ScannerBuilder

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

Set whether or not read operations should fill the cache.

Defaults to true.

pub fn omit_value(self, omit_value: bool) -> Self[−]

Set whether values of the user key should be omitted. When omit_value is true, the length of returned value will be 0.

Previously this option is called key_only.

Defaults to false.

pub fn isolation_level(self, isolation_level: IsolationLevel) -> Self[−]

Set the isolation level.

Defaults to IsolationLevel::Si.

pub fn range(self, lower_bound: Option<Key>, upper_bound: Option<Key>) -> Self[−]

Limit the range to [lower_bound, upper_bound) in which the ForwardKvScanner should scan. None means unbounded.

Default is (None, None).

pub fn bypass_locks(self, locks: TsSet) -> Self[−]

Set locks that the scanner can bypass. Locks with start_ts in the specified set will be ignored during scanning.

Default is empty.

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 check_has_newer_ts_data(self, enabled: bool) -> Self[−]

Check whether there is data with newer ts. The result of met_newer_ts_data is Unknown if this option is not set.

Default is false.

pub fn build(self) -> Result<Scanner<S>>[−]

Build Scanner from the current configuration.

pub fn build_entry_scanner(
    self,
    after_ts: TimeStamp,
    output_delete: bool
) -> Result<EntryScanner<S>>

pub fn build_delta_scanner(
    self,
    from_ts: TimeStamp,
    extra_op: ExtraOp
) -> Result<DeltaScanner<S>>