Struct AccumulatorArgs 

pub struct AccumulatorArgs<'a> {
    pub return_field: Arc<Field>,
    pub schema: &'a Schema,
    pub ignore_nulls: bool,
    pub order_bys: &'a [PhysicalSortExpr],
    pub is_reversed: bool,
    pub name: &'a str,
    pub is_distinct: bool,
    pub exprs: &'a [Arc<dyn PhysicalExpr>],
    pub expr_fields: &'a [Arc<Field>],
}

AccumulatorArgs contains information about how an aggregate function was called, including the types of its arguments and any optional ordering expressions.

Fields

return_field: Arc<Field>

The return field of the aggregate function.

schema: &'a Schema

Input schema to the aggregate function. If you need to check data type, nullability or metadata of input arguments then you should use expr_fields below instead.

ignore_nulls: bool

Whether to ignore nulls.

SQL allows the user to specify IGNORE NULLS, for example:

SELECT FIRST_VALUE(column1) IGNORE NULLS FROM t;

order_bys: &'a [PhysicalSortExpr]

The expressions in the ORDER BY clause passed to this aggregator.

SQL allows the user to specify the ordering of arguments to the aggregate using an ORDER BY. For example:

SELECT FIRST_VALUE(column1 ORDER BY column2) FROM t;

is_reversed: bool

Whether the aggregation is running in reverse order

name: &'a str

The name of the aggregate expression

is_distinct: bool

Whether the aggregate function is distinct.

SELECT COUNT(DISTINCT column1) FROM t;

exprs: &'a [Arc<dyn PhysicalExpr>]

The physical expression of arguments the aggregate function takes.

expr_fields: &'a [Arc<Field>]

Fields corresponding to each expr (same order & length).

Implementations

impl AccumulatorArgs<'_>

pub fn return_type(&self) -> &DataType

Returns the return type of the aggregate function.

Trait Implementations

impl<'a> Clone for AccumulatorArgs<'a>

fn clone(&self) -> AccumulatorArgs<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AccumulatorArgs<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a ForeignAccumulatorArgs> for AccumulatorArgs<'a>

fn from(value: &'a ForeignAccumulatorArgs) -> AccumulatorArgs<'a>

Converts to this type from the input type.