Struct datafusion::logical_expr::SimpleAggregateUDF
source · pub struct SimpleAggregateUDF { /* private fields */ }
Expand description
Implements AggregateUDFImpl
for functions that have a single signature and
return type.
Implementations§
source§impl SimpleAggregateUDF
impl SimpleAggregateUDF
sourcepub fn new(
name: impl Into<String>,
input_type: Vec<DataType>,
return_type: DataType,
volatility: Volatility,
accumulator: Arc<dyn Fn(AccumulatorArgs<'_>) -> Result<Box<dyn Accumulator>, DataFusionError> + Send + Sync>,
state_fields: Vec<Field>,
) -> SimpleAggregateUDF
pub fn new( name: impl Into<String>, input_type: Vec<DataType>, return_type: DataType, volatility: Volatility, accumulator: Arc<dyn Fn(AccumulatorArgs<'_>) -> Result<Box<dyn Accumulator>, DataFusionError> + Send + Sync>, state_fields: Vec<Field>, ) -> SimpleAggregateUDF
Create a new AggregateUDFImpl
from a name, input types, return type, state type and
implementation. Implementing AggregateUDFImpl
allows more flexibility
pub fn new_with_signature( name: impl Into<String>, signature: Signature, return_type: DataType, accumulator: Arc<dyn Fn(AccumulatorArgs<'_>) -> Result<Box<dyn Accumulator>, DataFusionError> + Send + Sync>, state_fields: Vec<Field>, ) -> SimpleAggregateUDF
Trait Implementations§
source§impl AggregateUDFImpl for SimpleAggregateUDF
impl AggregateUDFImpl for SimpleAggregateUDF
source§fn signature(&self) -> &Signature
fn signature(&self) -> &Signature
Returns the function’s
Signature
for information about what input
types are accepted and the function’s Volatility.source§fn return_type(
&self,
_arg_types: &[DataType],
) -> Result<DataType, DataFusionError>
fn return_type( &self, _arg_types: &[DataType], ) -> Result<DataType, DataFusionError>
What
DataType
will be returned by this function, given the types of
the argumentssource§fn accumulator(
&self,
acc_args: AccumulatorArgs<'_>,
) -> Result<Box<dyn Accumulator>, DataFusionError>
fn accumulator( &self, acc_args: AccumulatorArgs<'_>, ) -> Result<Box<dyn Accumulator>, DataFusionError>
Return a new
Accumulator
that aggregates values for a specific
group during query execution. Read moresource§fn state_fields(
&self,
_args: StateFieldsArgs<'_>,
) -> Result<Vec<Field>, DataFusionError>
fn state_fields( &self, _args: StateFieldsArgs<'_>, ) -> Result<Vec<Field>, DataFusionError>
Return the fields used to store the intermediate state of this accumulator. Read more
source§fn groups_accumulator_supported(&self, _args: AccumulatorArgs<'_>) -> bool
fn groups_accumulator_supported(&self, _args: AccumulatorArgs<'_>) -> bool
If the aggregate expression has a specialized
GroupsAccumulator
implementation. If this returns true,
[Self::create_groups_accumulator]
will be called. Read moresource§fn create_groups_accumulator(
&self,
_args: AccumulatorArgs<'_>,
) -> Result<Box<dyn GroupsAccumulator>, DataFusionError>
fn create_groups_accumulator( &self, _args: AccumulatorArgs<'_>, ) -> Result<Box<dyn GroupsAccumulator>, DataFusionError>
Return a specialized
GroupsAccumulator
that manages state
for all groups. Read moresource§fn aliases(&self) -> &[String]
fn aliases(&self) -> &[String]
Returns any aliases (alternate names) for this function. Read more
source§fn create_sliding_accumulator(
&self,
args: AccumulatorArgs<'_>,
) -> Result<Box<dyn Accumulator>, DataFusionError>
fn create_sliding_accumulator( &self, args: AccumulatorArgs<'_>, ) -> Result<Box<dyn Accumulator>, DataFusionError>
Sliding accumulator is an alternative accumulator that can be used for
window functions. It has retract method to revert the previous update. Read more
source§fn with_beneficial_ordering(
self: Arc<Self>,
_beneficial_ordering: bool,
) -> Result<Option<Arc<dyn AggregateUDFImpl>>, DataFusionError>
fn with_beneficial_ordering( self: Arc<Self>, _beneficial_ordering: bool, ) -> Result<Option<Arc<dyn AggregateUDFImpl>>, DataFusionError>
Sets the indicator whether ordering requirements of the AggregateUDFImpl is
satisfied by its input. If this is not the case, UDFs with order
sensitivity
AggregateOrderSensitivity::Beneficial
can still produce
the correct result with possibly more work internally. Read moresource§fn order_sensitivity(&self) -> AggregateOrderSensitivity
fn order_sensitivity(&self) -> AggregateOrderSensitivity
Gets the order sensitivity of the UDF. See
AggregateOrderSensitivity
for possible options.source§fn simplify(
&self,
) -> Option<Box<dyn Fn(AggregateFunction, &dyn SimplifyInfo) -> Result<Expr, DataFusionError>>>
fn simplify( &self, ) -> Option<Box<dyn Fn(AggregateFunction, &dyn SimplifyInfo) -> Result<Expr, DataFusionError>>>
Optionally apply per-UDaF simplification / rewrite rules. Read more
source§fn reverse_expr(&self) -> ReversedUDAF
fn reverse_expr(&self) -> ReversedUDAF
Returns the reverse expression of the aggregate function.
source§fn coerce_types(
&self,
_arg_types: &[DataType],
) -> Result<Vec<DataType>, DataFusionError>
fn coerce_types( &self, _arg_types: &[DataType], ) -> Result<Vec<DataType>, DataFusionError>
Coerce arguments of a function call to types that the function can evaluate. Read more
Auto Trait Implementations§
impl Freeze for SimpleAggregateUDF
impl !RefUnwindSafe for SimpleAggregateUDF
impl Send for SimpleAggregateUDF
impl Sync for SimpleAggregateUDF
impl Unpin for SimpleAggregateUDF
impl !UnwindSafe for SimpleAggregateUDF
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more