Enum datafusion_expr::aggregate_function::AggregateFunction

pub enum AggregateFunction {
    Count,
    Sum,
    Min,
    Max,
    Avg,
    Median,
    ApproxDistinct,
    ArrayAgg,
    FirstValue,
    LastValue,
    NthValue,
    Variance,
    VariancePop,
    Stddev,
    StddevPop,
    Covariance,
    CovariancePop,
    Correlation,
    RegrSlope,
    RegrIntercept,
    RegrCount,
    RegrR2,
    RegrAvgx,
    RegrAvgy,
    RegrSXX,
    RegrSYY,
    RegrSXY,
    ApproxPercentileCont,
    ApproxPercentileContWithWeight,
    ApproxMedian,
    Grouping,
    BitAnd,
    BitOr,
    BitXor,
    BoolAnd,
    BoolOr,
    StringAgg,
}

Enum of all built-in aggregate functions

Variants

Count

Count

Sum

Sum

Min

Minimum

Max

Maximum

Avg

Average

Median

Median

ApproxDistinct

Approximate distinct function

ArrayAgg

Aggregation into an array

FirstValue

First value in a group according to some ordering

LastValue

Last value in a group according to some ordering

NthValue

N’th value in a group according to some ordering

Variance

Variance (Sample)

VariancePop

Variance (Population)

Stddev

Standard Deviation (Sample)

StddevPop

Standard Deviation (Population)

Covariance

Covariance (Sample)

CovariancePop

Covariance (Population)

Correlation

Correlation

RegrSlope

Slope from linear regression

RegrIntercept

Intercept from linear regression

RegrCount

Number of input rows in which both expressions are not null

RegrR2

R-squared value from linear regression

RegrAvgx

Average of the independent variable

RegrAvgy

Average of the dependent variable

RegrSXX

Sum of squares of the independent variable

RegrSYY

Sum of squares of the dependent variable

RegrSXY

Sum of products of pairs of numbers

ApproxPercentileCont

Approximate continuous percentile function

ApproxPercentileContWithWeight

Approximate continuous percentile function with weight

ApproxMedian

ApproxMedian

Grouping

Grouping

BitAnd

Bit And

BitOr

Bit Or

BitXor

Bit Xor

BoolAnd

Bool And

BoolOr

Bool Or

StringAgg

String aggregation

Implementations

impl AggregateFunction

pub fn name(&self) -> &str

impl AggregateFunction

pub fn return_type(&self, input_expr_types: &[DataType]) -> Result<DataType>

Returns the datatype of the aggregate function given its argument types

This is used to get the returned data type for aggregate expr.

impl AggregateFunction

pub fn signature(&self) -> Signature

the signatures supported by the function fun.

Trait Implementations

impl Clone for AggregateFunction

fn clone(&self) -> AggregateFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AggregateFunction

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

Formats the value using the given formatter.

impl Display for AggregateFunction

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

Formats the value using the given formatter.

impl FromStr for AggregateFunction

type Err = DataFusionError

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<AggregateFunction>

Parses a string s to return a value of this type.

impl Hash for AggregateFunction

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 IntoEnumIterator for AggregateFunction

type Iterator = AggregateFunctionIter

fn iter() -> AggregateFunctionIter

impl PartialEq for AggregateFunction

fn eq(&self, other: &AggregateFunction) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AggregateFunction

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for AggregateFunction

impl StructuralPartialEq for AggregateFunction