Enum SpatialFilter 

pub enum SpatialFilter {
    Intersects(Column, BoundingBox),
    Covers(Column, BoundingBox),
    HasZ(Column),
    And(Box<SpatialFilter>, Box<SpatialFilter>),
    Or(Box<SpatialFilter>, Box<SpatialFilter>),
    LiteralFalse,
    Unknown,
}

Simplified parsed spatial filter

This enumerator represents a parsed version of the PhysicalExpr provided as a filter to an implementation of a table provider or file opener. This is intended as a means by which to process an arbitrary PhysicalExpr against column statistics to attempt pruning unnecessary files or parts of files specifically with respect to a spatial filter (i.e., non-spatial filters we leave to an underlying implementation).

Variants

Intersects(Column, BoundingBox)

ST_Intersects(<column>, <literal>) or ST_Intersects(<literal>, <column>)

Covers(Column, BoundingBox)

ST_Covers(<column>, <literal>) or ST_Covers(<literal>, <column>)

HasZ(Column)

ST_HasZ(<column>)

And(Box<SpatialFilter>, Box<SpatialFilter>)

Logical AND

Or(Box<SpatialFilter>, Box<SpatialFilter>)

Logical OR

LiteralFalse

A literal FALSE, which is never true

Unknown

An expression we don’t know about, which we assume could be true

Implementations

impl SpatialFilter

pub fn filter_bbox(&self, column_name: &str) -> BoundingBox

Compute the maximum extent of a filter for a specific column index

Some spatial file formats have the ability to push down a bounding box into an index. This function allows deriving that bounding box based on what DataFusion provides, which is a physical expression.

Note that this always succeeds; however, for a non-spatial expression or a non-spatial expression that is unsupported, the full bounding box is returned.

pub fn evaluate(&self, table_stats: &TableGeoStatistics) -> Result<bool>

Returns true if there is any chance the expression might be true

In other words, returns false if and only if the expression is guaranteed to be false.

pub fn try_from_expr(expr: &Arc<dyn PhysicalExpr>) -> Result<Self>

Construct a SpatialPredicate from a PhysicalExpr

Parses expr to extract known expressions we can evaluate against statistics.

Trait Implementations

impl Clone for SpatialFilter

fn clone(&self) -> SpatialFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpatialFilter

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

Formats the value using the given formatter.