Struct ScannerProperties

pub struct ScannerProperties {
    pub partitions: Vec<Vec<PartitionRange>>,
    append_mode: bool,
    total_rows: usize,
    pub distinguish_partition_range: bool,
    target_partitions: usize,
}

Properties of the RegionScanner.

Fields

partitions: Vec<Vec<PartitionRange>>

A 2-dim partition ranges.

The first dim vector’s length represents the output partition number. The second dim is ranges within one partition.

append_mode: bool

Whether scanner is in append-only mode.

total_rows: usize

Total rows that may return by scanner. This field is only read iff ScannerProperties::append_mode is true.

distinguish_partition_range: bool

Whether to yield an empty batch to distinguish partition ranges.

target_partitions: usize

The target partitions of the scanner. 0 indicates using the number of partitions as target partitions.

Implementations

impl ScannerProperties

pub fn with_append_mode(self, append_mode: bool) -> Self

Sets append mode for scanner.

pub fn with_total_rows(self, total_rows: usize) -> Self

Sets total rows for scanner.

pub fn new( partitions: Vec<Vec<PartitionRange>>, append_mode: bool, total_rows: usize, ) -> Self

Creates a new ScannerProperties with the given partitioning.

pub fn prepare(&mut self, request: PrepareRequest)

Updates the properties with the given PrepareRequest.

pub fn num_partitions(&self) -> usize

Returns the number of actual partitions.

pub fn append_mode(&self) -> bool

pub fn total_rows(&self) -> usize

pub fn target_partitions(&self) -> usize

Returns the target partitions of the scanner. If it is not set, returns the number of partitions.

Trait Implementations

impl Debug for ScannerProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScannerProperties

fn default() -> ScannerProperties

Returns the “default value” for a type.