Struct InputDistributionRequirements 

#[non_exhaustive]
pub struct InputDistributionRequirements { /* private fields */ }

Distribution requirements for an ExecutionPlan’s inputs.

InputDistributionRequirements describes what distribution an operator requires from each child.

• Self::new describes independent per-child requirements.
• Self::co_partitioned additionally requires child partitions with the same index to cover compatible key ranges.

For a single-input aggregate:

AggregateExec
  child 0 requirement: KeyPartitioned(group_exprs)

each input partition can aggregate its own key domain independently.

For a partitioned join:

HashJoinExec
  child 0 requirement: KeyPartitioned(left_keys)
  child 1 requirement: KeyPartitioned(right_keys)

  partition 0: join(left partition 0, right partition 0)
  partition 1: join(left partition 1, right partition 1)
  partition 2: join(left partition 2, right partition 2)

each child must satisfy its own key requirement. In addition, matching partition indexes must be safe to process together.

Implementations

impl InputDistributionRequirements

pub fn new(per_child: Vec<Distribution>) -> InputDistributionRequirements

Create independent per-child requirements.

pub fn co_partitioned( per_child: Vec<Distribution>, ) -> InputDistributionRequirements

Create a requirement that all children are co-partitioned.

Each child must satisfy its own Distribution. Matching partition indexes are processed together:

left:  Range(left.a ASC,  split_points=[10, 20])
right: Range(right.x ASC, split_points=[10, 20])

partition 0 from both sides contains keys before 10
partition 1 from both sides contains keys in [10, 20)
partition 2 from both sides contains keys at/after 20

If the split points differ, partition i from one side no longer covers the same key range as partition i from the other side.

pub fn per_child_distributions(&self) -> impl ExactSizeIterator

Return the per-child distribution requirements.

pub fn child_distribution(&self, child_idx: usize) -> Option<&Distribution>

Return the distribution requirement for a child.

pub fn into_per_child(self) -> Vec<Distribution>

Return the per-child distribution requirements.

WARNING: This intentionally drops any grouped relationship.

pub fn child_satisfaction( &self, child_idx: usize, child: &(dyn ExecutionPlan + 'static), options: ChildSatisfactionOptions, ) -> Result<PartitioningSatisfaction, DataFusionError>

Returns how a child satisfies its distribution requirement.

This preserves the requirement set’s satisfaction policy.

Trait Implementations

impl Clone for InputDistributionRequirements

fn clone(&self) -> InputDistributionRequirements

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputDistributionRequirements

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

Formats the value using the given formatter.