Enum ExecutionMode

pub enum ExecutionMode {
    Bounded,
    Unbounded,
    PipelineBreaking,
}

Describes the execution mode of the result of calling ExecutionPlan::execute with respect to its size and behavior.

The mode of the execution plan is determined by the mode of its input execution plans and the details of the operator itself. For example, a FilterExec operator will have the same execution mode as its input, but a SortExec operator may have a different execution mode than its input, depending on how the input stream is sorted.

There are three possible execution modes: Bounded, Unbounded and PipelineBreaking.

Variants

Bounded

The stream is bounded / finite.

In this case the stream will eventually return None to indicate that there are no more records to process.

Unbounded

The stream is unbounded / infinite.

In this case, the stream will never be done (never return None), except in case of error.

This mode is often used in “Steaming” use cases where data is incrementally processed as it arrives.

Note that even though the operator generates an unbounded stream of results, it can execute with bounded memory and incrementally produces output.

PipelineBreaking

Some of the operator’s input stream(s) are unbounded, but the operator cannot generate streaming results from these streaming inputs.

In this case, the execution mode will be pipeline breaking, e.g. the operator requires unbounded memory to generate results. This information is used by the planner when performing sanity checks on plans processings unbounded data sources.

Implementations

impl ExecutionMode

pub fn is_unbounded(&self) -> bool

Check whether the execution mode is unbounded or not.

pub fn pipeline_friendly(&self) -> bool

Check whether the execution is pipeline friendly. If so, operator can execute safely.

Trait Implementations

impl Clone for ExecutionMode

fn clone(&self) -> ExecutionMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutionMode

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

Formats the value using the given formatter.

impl PartialEq for ExecutionMode

fn eq(&self, other: &ExecutionMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ExecutionMode

impl StructuralPartialEq for ExecutionMode