Struct datafusion_expr::logical_plan::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 group_expr_len(&self) -> Result<usize>

Get the length of the group by expression in the output schema This is not simply group by expression length. Expression may be GroupingSet, etc. In these case we need to get inner expression lengths.

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.

impl Debug for Aggregate

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

Formats the value using the given formatter.

impl Hash for Aggregate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Aggregate

fn eq(&self, other: &Aggregate) -> 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 Eq for Aggregate

impl StructuralPartialEq for Aggregate