Struct SpatialJoinExec 

pub struct SpatialJoinExec {
    pub left: Arc<dyn ExecutionPlan>,
    pub right: Arc<dyn ExecutionPlan>,
    pub on: SpatialPredicate,
    pub filter: Option<JoinFilter>,
    pub join_type: JoinType,
    pub metrics: ExecutionPlanMetricsSet,
    /* private fields */
}

Physical execution plan for performing spatial joins between two tables. It uses a spatial index to speed up the join operation.

Algorithm Overview

The spatial join execution follows a hash-join-like pattern:

1. Build Phase: The left (smaller) table geometries are indexed using a spatial index
2. Probe Phase: Each geometry from the right table is used to query the spatial index
3. Refinement: Candidate pairs from the index are refined using exact spatial predicates
4. Output: Matching pairs are combined according to the specified join type

Fields

left: Arc<dyn ExecutionPlan>

left (build) side which gets hashed

right: Arc<dyn ExecutionPlan>

right (probe) side which are filtered by the hash table

on: SpatialPredicate

Primary spatial join condition (the expression in the ON clause of the join)

filter: Option<JoinFilter>

Additional filters which are applied while finding matching rows. It could contain part of the ON clause, or expressions in the WHERE clause.

join_type: JoinType

How the join is performed (OUTER, INNER, etc)

metrics: ExecutionPlanMetricsSet

Metrics for tracking execution statistics (public for wrapper implementations)

Implementations

impl SpatialJoinExec

pub fn try_new( left: Arc<dyn ExecutionPlan>, right: Arc<dyn ExecutionPlan>, on: SpatialPredicate, filter: Option<JoinFilter>, join_type: &JoinType, projection: Option<Vec<usize>>, options: &SpatialJoinOptions, ) -> Result<Self>

Try to create a new SpatialJoinExec

pub fn try_new_internal( left: Arc<dyn ExecutionPlan>, right: Arc<dyn ExecutionPlan>, on: SpatialPredicate, filter: Option<JoinFilter>, join_type: &JoinType, projection: Option<Vec<usize>>, seed: u64, ) -> Result<Self>

Create a new SpatialJoinExec with additional options

pub fn join_type(&self) -> &JoinType

How the join is performed

pub fn contains_projection(&self) -> bool

Does this join has a projection on the joined columns

pub fn swap_inputs(&self) -> Result<Arc<dyn ExecutionPlan>>

Returns a new ExecutionPlan that runs NestedLoopsJoins with the left and right inputs swapped.

Notes:

This function should be called BEFORE inserting any repartitioning operators on the join’s children. Check [super::HashJoinExec::swap_inputs] for more details.

pub fn with_projection(&self, projection: Option<Vec<usize>>) -> Result<Self>

Trait Implementations

impl Debug for SpatialJoinExec

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

Formats the value using the given formatter.

impl DisplayAs for SpatialJoinExec

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

Format according to DisplayFormatType, used when verbose representation looks different from the default one

impl EmbeddedProjection for SpatialJoinExec

fn with_projection(&self, projection: Option<Vec<usize>>) -> Result<Self>

impl ExecutionPlan for SpatialJoinExec

fn try_swapping_with_projection( &self, projection: &ProjectionExec, ) -> Result<Option<Arc<dyn ExecutionPlan>>>

Tries to push projection down through SpatialJoinExec. If possible, performs the pushdown and returns a new SpatialJoinExec as the top plan which has projections as its children. Otherwise, returns None.

fn name(&self) -> &str

Short name for the ExecutionPlan, such as ‘DataSourceExec’.

fn as_any(&self) -> &dyn Any

Returns the execution plan as Any so that it can be downcast to a specific implementation.

fn properties(&self) -> &PlanProperties

Return properties of the output of the ExecutionPlan, such as output ordering(s), partitioning information etc.

fn maintains_input_order(&self) -> Vec<bool>

Returns false if this ExecutionPlan’s implementation may reorder rows within or between partitions.

fn children(&self) -> Vec<&Arc<dyn ExecutionPlan>>

Get a list of children ExecutionPlans that act as inputs to this plan. The returned list will be empty for leaf nodes such as scans, will contain a single value for unary nodes, or two values for binary nodes (such as joins).

fn with_new_children( self: Arc<Self>, children: Vec<Arc<dyn ExecutionPlan>>, ) -> Result<Arc<dyn ExecutionPlan>>

Returns a new ExecutionPlan where all existing children were replaced by the children, in order

fn metrics(&self) -> Option<MetricsSet>

Return a snapshot of the set of Metrics for this ExecutionPlan. If no Metrics are available, return None.

fn execute( &self, partition: usize, context: Arc<TaskContext>, ) -> Result<SendableRecordBatchStream>

Begin execution of partition, returning a Stream of RecordBatches.

fn static_name() -> &'static str

where Self: Sized,

Short name for the ExecutionPlan, such as ‘DataSourceExec’. Like name but can be called without an instance.

fn schema(&self) -> Arc<Schema>

Get the schema for this execution plan

fn check_invariants(&self, check: InvariantLevel) -> Result<(), DataFusionError>

Returns an error if this individual node does not conform to its invariants. These invariants are typically only checked in debug mode.

fn required_input_distribution(&self) -> Vec<Distribution>

Specifies the data distribution requirements for all the children for this ExecutionPlan, By default it’s [Distribution::UnspecifiedDistribution] for each child,

fn required_input_ordering(&self) -> Vec<Option<OrderingRequirements>>

Specifies the ordering required for all of the children of this ExecutionPlan.

fn benefits_from_input_partitioning(&self) -> Vec<bool>

Specifies whether the ExecutionPlan benefits from increased parallelization at its input for each child.

fn reset_state( self: Arc<Self>, ) -> Result<Arc<dyn ExecutionPlan>, DataFusionError>

Reset any internal state within this ExecutionPlan.

fn repartitioned( &self, _target_partitions: usize, _config: &ConfigOptions, ) -> Result<Option<Arc<dyn ExecutionPlan>>, DataFusionError>

If supported, attempt to increase the partitioning of this ExecutionPlan to produce target_partitions partitions.

fn statistics(&self) -> Result<Statistics, DataFusionError>

👎Deprecated since 48.0.0: Use partition_statistics method instead

Returns statistics for this ExecutionPlan node. If statistics are not available, should return Statistics::new_unknown (the default), not an error.

fn partition_statistics( &self, partition: Option<usize>, ) -> Result<Statistics, DataFusionError>

Returns statistics for a specific partition of this ExecutionPlan node. If statistics are not available, should return Statistics::new_unknown (the default), not an error. If partition is None, it returns statistics for the entire plan.

fn supports_limit_pushdown(&self) -> bool

Returns true if a limit can be safely pushed down through this ExecutionPlan node.

fn with_fetch(&self, _limit: Option<usize>) -> Option<Arc<dyn ExecutionPlan>>

Returns a fetching variant of this ExecutionPlan node, if it supports fetch limits. Returns None otherwise.

fn fetch(&self) -> Option<usize>

Gets the fetch count for the operator, None means there is no fetch.

fn cardinality_effect(&self) -> CardinalityEffect

Gets the effect on cardinality, if known

fn gather_filters_for_pushdown( &self, _phase: FilterPushdownPhase, parent_filters: Vec<Arc<dyn PhysicalExpr>>, _config: &ConfigOptions, ) -> Result<FilterDescription, DataFusionError>

Collect filters that this node can push down to its children. Filters that are being pushed down from parents are passed in, and the node may generate additional filters to push down. For example, given the plan FilterExec -> HashJoinExec -> DataSourceExec, what will happen is that we recurse down the plan calling ExecutionPlan::gather_filters_for_pushdown:

fn handle_child_pushdown_result( &self, _phase: FilterPushdownPhase, child_pushdown_result: ChildPushdownResult, _config: &ConfigOptions, ) -> Result<FilterPushdownPropagation<Arc<dyn ExecutionPlan>>, DataFusionError>

Handle the result of a child pushdown. This method is called as we recurse back up the plan tree after pushing filters down to child nodes via ExecutionPlan::gather_filters_for_pushdown. It allows the current node to process the results of filter pushdown from its children, deciding whether to absorb filters, modify the plan, or pass filters back up to its parent.

fn with_new_state( &self, _state: Arc<dyn Any + Send + Sync>, ) -> Option<Arc<dyn ExecutionPlan>>

Injects arbitrary run-time state into this execution plan, returning a new plan instance that incorporates that state if it is relevant to the concrete node implementation.