Struct ScanPredicate

pub struct ScanPredicate {
    pub predicate: Arc<dyn PhysicalExpr>,
    pub live_columns: Arc<PlIndexSet<PlSmallStr>>,
    pub skip_batch_predicate: Option<Arc<dyn PhysicalExpr>>,
    pub column_predicates: PhysicalColumnPredicates,
    pub hive_predicate: Option<Arc<dyn PhysicalExpr>>,
    pub hive_predicate_is_full_predicate: bool,
}

All the expressions and metadata used to filter out rows using predicates.

Fields

predicate: Arc<dyn PhysicalExpr>

live_columns: Arc<PlIndexSet<PlSmallStr>>

Column names that are used in the predicate.

skip_batch_predicate: Option<Arc<dyn PhysicalExpr>>

A predicate expression used to skip record batches based on its statistics.

This expression will be given a batch size along with a min, max and null count for each live column (set to null when it is not known) and the expression evaluates to true if the whole batch can for sure be skipped. This may be conservative and evaluate to false even when the batch could theoretically be skipped.

column_predicates: PhysicalColumnPredicates

Partial predicates for each column for filter when loading columnar formats.

hive_predicate: Option<Arc<dyn PhysicalExpr>>

Predicate only referring to hive columns.

hive_predicate_is_full_predicate: bool

Implementations

impl ScanPredicate

pub fn with_constant_columns( &self, constant_columns: impl IntoIterator<Item = (PlSmallStr, Scalar)>, ) -> Self

pub fn to_io( &self, skip_batch_predicate: Option<&Arc<dyn SkipBatchPredicate>>, schema: SchemaRef, ) -> ScanIOPredicate

Trait Implementations

impl Clone for ScanPredicate

fn clone(&self) -> ScanPredicate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScanPredicate

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

Formats the value using the given formatter.