Struct datafusion_expr::expr::AggregateFunction

pub struct AggregateFunction {
    pub func: Arc<AggregateUDF>,
    pub args: Vec<Expr>,
    pub distinct: bool,
    pub filter: Option<Box<Expr>>,
    pub order_by: Option<Vec<Expr>>,
    pub null_treatment: Option<NullTreatment>,
}

Aggregate function

See also ExprFunctionExt to set these fields on Expr

Fields

func: Arc<AggregateUDF>

Name of the function

args: Vec<Expr>

List of expressions to feed to the functions as arguments

distinct: bool

Whether this is a DISTINCT aggregation or not

filter: Option<Box<Expr>>

Optional filter

order_by: Option<Vec<Expr>>

Optional ordering

null_treatment: Option<NullTreatment>

Implementations

impl AggregateFunction

pub fn new_udf( func: Arc<AggregateUDF>, args: Vec<Expr>, distinct: bool, filter: Option<Box<Expr>>, order_by: Option<Vec<Expr>>, null_treatment: Option<NullTreatment>, ) -> Self

Create a new AggregateFunction expression with a user-defined function (UDF)

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

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

impl StructuralPartialEq for AggregateFunction