Struct datafusion_expr::Aggregate

#[non_exhaustive]
pub struct Aggregate {
    pub input: Arc<LogicalPlan>,
    pub group_expr: Vec<Expr>,
    pub aggr_expr: Vec<Expr>,
    pub schema: DFSchemaRef,
}

Aggregates its input based on a set of grouping and aggregate expressions (e.g. SUM).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

input: Arc<LogicalPlan>

The incoming logical plan

group_expr: Vec<Expr>

Grouping expressions

aggr_expr: Vec<Expr>

Aggregate expressions

schema: DFSchemaRef

The schema description of the aggregate output

Implementations

impl Aggregate

pub fn try_new( input: Arc<LogicalPlan>, group_expr: Vec<Expr>, aggr_expr: Vec<Expr> ) -> Result<Self>

Create a new aggregate operator.

pub fn try_new_with_schema( input: Arc<LogicalPlan>, group_expr: Vec<Expr>, aggr_expr: Vec<Expr>, schema: DFSchemaRef ) -> Result<Self>

Create a new aggregate operator using the provided schema to avoid the overhead of building the schema again when the schema is already known.

This method should only be called when you are absolutely sure that the schema being provided is correct for the aggregate. If in doubt, call try_new instead.

pub fn try_from_plan(plan: &LogicalPlan) -> Result<&Aggregate>

Trait Implementations

impl Clone for Aggregate

fn clone(&self) -> Aggregate

Returns a copy of the value.

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

Performs copy-assignment from source.