Struct datafusion::physical_plan::aggregates::AggregateExec
source · pub struct AggregateExec { /* private fields */ }
Expand description
Hash aggregate execution plan
Implementations§
source§impl AggregateExec
impl AggregateExec
sourcepub fn try_new(
mode: AggregateMode,
group_by: PhysicalGroupBy,
aggr_expr: Vec<Arc<dyn AggregateExpr>>,
filter_expr: Vec<Option<Arc<dyn PhysicalExpr>>>,
order_by_expr: Vec<Option<LexOrdering>>,
input: Arc<dyn ExecutionPlan>,
input_schema: SchemaRef
) -> Result<Self>
pub fn try_new( mode: AggregateMode, group_by: PhysicalGroupBy, aggr_expr: Vec<Arc<dyn AggregateExpr>>, filter_expr: Vec<Option<Arc<dyn PhysicalExpr>>>, order_by_expr: Vec<Option<LexOrdering>>, input: Arc<dyn ExecutionPlan>, input_schema: SchemaRef ) -> Result<Self>
Create a new hash aggregate execution plan
sourcepub fn mode(&self) -> &AggregateMode
pub fn mode(&self) -> &AggregateMode
Aggregation mode (full, partial)
sourcepub fn group_expr(&self) -> &PhysicalGroupBy
pub fn group_expr(&self) -> &PhysicalGroupBy
Grouping expressions
sourcepub fn output_group_expr(&self) -> Vec<Arc<dyn PhysicalExpr>>
pub fn output_group_expr(&self) -> Vec<Arc<dyn PhysicalExpr>>
Grouping expressions as they occur in the output schema
sourcepub fn aggr_expr(&self) -> &[Arc<dyn AggregateExpr>]
pub fn aggr_expr(&self) -> &[Arc<dyn AggregateExpr>]
Aggregate expressions
sourcepub fn filter_expr(&self) -> &[Option<Arc<dyn PhysicalExpr>>]
pub fn filter_expr(&self) -> &[Option<Arc<dyn PhysicalExpr>>]
FILTER (WHERE clause) expression for each aggregate expression
sourcepub fn order_by_expr(&self) -> &[Option<LexOrdering>]
pub fn order_by_expr(&self) -> &[Option<LexOrdering>]
ORDER BY clause expression for each aggregate expression
sourcepub fn input(&self) -> &Arc<dyn ExecutionPlan>
pub fn input(&self) -> &Arc<dyn ExecutionPlan>
Input plan
sourcepub fn input_schema(&self) -> SchemaRef
pub fn input_schema(&self) -> SchemaRef
Get the input schema before any aggregates are applied
Trait Implementations§
source§impl Debug for AggregateExec
impl Debug for AggregateExec
source§impl ExecutionPlan for AggregateExec
impl ExecutionPlan for AggregateExec
source§fn output_partitioning(&self) -> Partitioning
fn output_partitioning(&self) -> Partitioning
Get the output partitioning of this plan
source§fn unbounded_output(&self, children: &[bool]) -> Result<bool>
fn unbounded_output(&self, children: &[bool]) -> Result<bool>
Specifies whether this plan generates an infinite stream of records. If the plan does not support pipelining, but its input(s) are infinite, returns an error to indicate this.
source§fn output_ordering(&self) -> Option<&[PhysicalSortExpr]>
fn output_ordering(&self) -> Option<&[PhysicalSortExpr]>
If the output of this operator within each partition is sorted,
returns
Some(keys)
with the description of how it was sorted. Read moresource§fn required_input_distribution(&self) -> Vec<Distribution>
fn required_input_distribution(&self) -> Vec<Distribution>
Specifies the data distribution requirements for all the
children for this operator, By default it’s [Distribution::UnspecifiedDistribution] for each child,
source§fn required_input_ordering(&self) -> Vec<Option<LexOrderingReq>>
fn required_input_ordering(&self) -> Vec<Option<LexOrderingReq>>
Specifies the ordering requirements for all of the children
For each child, it’s the local ordering requirement within
each partition rather than the global ordering Read more
source§fn equivalence_properties(&self) -> EquivalenceProperties
fn equivalence_properties(&self) -> EquivalenceProperties
Get the EquivalenceProperties within the plan
source§fn children(&self) -> Vec<Arc<dyn ExecutionPlan>>
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).
source§fn with_new_children(
self: Arc<Self>,
children: Vec<Arc<dyn ExecutionPlan>>
) -> Result<Arc<dyn ExecutionPlan>>
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.
source§fn execute(
&self,
partition: usize,
context: Arc<TaskContext>
) -> Result<SendableRecordBatchStream>
fn execute( &self, partition: usize, context: Arc<TaskContext> ) -> Result<SendableRecordBatchStream>
creates an iterator
source§fn metrics(&self) -> Option<MetricsSet>
fn metrics(&self) -> Option<MetricsSet>
source§fn statistics(&self) -> Statistics
fn statistics(&self) -> Statistics
Returns the global output statistics for this
ExecutionPlan
node.source§fn maintains_input_order(&self) -> Vec<bool>
fn maintains_input_order(&self) -> Vec<bool>
Returns
false
if this operator’s implementation may reorder
rows within or between partitions. Read moresource§fn benefits_from_input_partitioning(&self) -> bool
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 Read moresource§fn ordering_equivalence_properties(&self) -> OrderingEquivalenceProperties
fn ordering_equivalence_properties(&self) -> OrderingEquivalenceProperties
Get the OrderingEquivalenceProperties within the plan
Auto Trait Implementations§
impl !RefUnwindSafe for AggregateExec
impl Send for AggregateExec
impl Sync for AggregateExec
impl Unpin for AggregateExec
impl !UnwindSafe for AggregateExec
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more