Struct RelationPredicate 

pub struct RelationPredicate {
    pub left: Arc<dyn PhysicalExpr>,
    pub right: Arc<dyn PhysicalExpr>,
    pub relation_type: SpatialRelationType,
}

Spatial relation predicate for topological relationships.

This predicate represents a spatial join condition based on topological relationships between geometries, such as intersects, contains, within, etc. It follows the DE-9IM (Dimensionally Extended 9-Intersection Model) spatial relations.

Example SQL

SELECT * FROM buildings b JOIN parcels p
ON ST_Intersects(b.geometry, p.geometry)

Supported Relations

• Intersects - Geometries share at least one point
• Contains - Left geometry contains the right geometry
• Within - Left geometry is within the right geometry
• Covers - Left geometry covers the right geometry
• CoveredBy - Left geometry is covered by the right geometry
• Touches - Geometries touch at their boundaries
• Crosses - Geometries cross each other
• Overlaps - Geometries overlap
• Equals - Geometries are spatially equal

Fields

left: Arc<dyn PhysicalExpr>

The expression for evaluating the geometry value on the left side. The expression should be evaluated directly on the left side batches.

right: Arc<dyn PhysicalExpr>

The expression for evaluating the geometry value on the right side. The expression should be evaluated directly on the right side batches.

relation_type: SpatialRelationType

The spatial relation type.

Implementations

impl RelationPredicate

pub fn new( left: Arc<dyn PhysicalExpr>, right: Arc<dyn PhysicalExpr>, relation_type: SpatialRelationType, ) -> Self

Creates a new spatial relation predicate.

Arguments

• left - Expression for the left side geometry
• right - Expression for the right side geometry
• relation_type - The type of spatial relationship to test

Trait Implementations

impl Clone for RelationPredicate

fn clone(&self) -> RelationPredicate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelationPredicate

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

Formats the value using the given formatter.

impl Display for RelationPredicate

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

Formats the value using the given formatter.

impl SpatialPredicateTrait for RelationPredicate

fn swap_for_swapped_children(&self) -> Self

Returns a semantically equivalent predicate after the join children are swapped.

fn update_for_child_projections( &self, projected_left_exprs: &[ProjectionExpr], projected_right_exprs: &[ProjectionExpr], ) -> Result<Option<Self>>

Rewrites the predicate to reference projected child expressions.