Struct 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 const INTERNAL_GROUPING_ID: &'static str = "__grouping_id"

Internal column used when the aggregation is a grouping set.

This column contains a bitmask where each bit represents a grouping expression. The least significant bit corresponds to the rightmost grouping expression. A bit value of 0 indicates that the corresponding column is included in the grouping set, while a value of 1 means it is excluded.

For example, for the grouping expressions CUBE(a, b), the grouping ID column will have the following values: 0b00: Both a and b are included 0b01: b is excluded 0b10: a is excluded 0b11: Both a and b are excluded

This internal column is necessary because excluded columns are replaced with NULL values. To handle these cases correctly, we must distinguish between an actual NULL value in a column and a column being excluded from the set.

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.

pub fn grouping_id_type(group_exprs: usize) -> DataType

Returns the data type of the grouping id. The grouping ID value is a bitmask where each set bit indicates that the corresponding grouping expression is null

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 PartialOrd for Aggregate

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Aggregate

impl StructuralPartialEq for Aggregate