Struct datafusion::physical_plan::aggregates::AggregateExec

pub struct AggregateExec { /* private fields */ }

Hash aggregate execution plan

Implementations

impl AggregateExec

pub fn try_new(
    mode: AggregateMode,
    group_by: PhysicalGroupBy,
    aggr_expr: Vec<Arc<dyn AggregateExpr>>,
    input: Arc<dyn ExecutionPlan>,
    input_schema: SchemaRef
) -> Result<Self>

Create a new hash aggregate execution plan

pub fn mode(&self) -> &AggregateMode

Aggregation mode (full, partial)

pub fn group_expr(&self) -> &PhysicalGroupBy

Grouping expressions

pub fn output_group_expr(&self) -> Vec<Arc<dyn PhysicalExpr>>

Grouping expressions as they occur in the output schema

pub fn aggr_expr(&self) -> &[Arc<dyn AggregateExpr>]

Aggregate expressions

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

Input plan

pub fn input_schema(&self) -> SchemaRef

Get the input schema before any aggregates are applied

Trait Implementations

impl Debug for AggregateExec

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

Formats the value using the given formatter.

impl ExecutionPlan for AggregateExec

fn as_any(&self) -> &dyn Any

Return a reference to Any that can be used for down-casting

fn output_partitioning(&self) -> Partitioning

Get the output partitioning of this plan

fn schema(&self) -> SchemaRef

Get the schema for this execution plan

fn output_ordering(&self) -> Option<&[PhysicalSortExpr]>

If the output of this operator is sorted, returns Some(keys) with the description of how it was sorted.

fn required_child_distribution(&self) -> Distribution

Specifies the data distribution requirements of all the children for this operator

fn relies_on_input_order(&self) -> bool

Returns true if this operator relies on its inputs being produced in a certain order (for example that they are sorted a particular way) for correctness.

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

Get a list of child execution plans that provide the input for this plan. The returned list will be empty for leaf nodes, 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 plan where all children were replaced by new plans.

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

creates an iterator

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

Return a snapshot of the set of Metrics for this ExecutionPlan.

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

Format this ExecutionPlan to f in the specified type.

fn statistics(&self) -> Statistics

Returns the global output statistics for this ExecutionPlan node.

fn maintains_input_order(&self) -> bool

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

fn benefits_from_input_partitioning(&self) -> bool

Returns true if this operator would benefit from partitioning its input (and thus from more parallelism). For operators that do very little work the overhead of extra parallelism may outweigh any benefits