Struct datafusion_expr::test::function_stub::Max
source · pub struct Max { /* private fields */ }
Expand description
Testing stub implementation of MAX aggregate
Implementations§
Trait Implementations§
source§impl AggregateUDFImpl for Max
impl AggregateUDFImpl for Max
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>
fn return_type(&self, _arg_types: &[DataType]) -> Result<DataType>
What
DataType
will be returned by this function, given the types of
the argumentssource§fn state_fields(&self, _args: StateFieldsArgs<'_>) -> Result<Vec<Field>>
fn state_fields(&self, _args: StateFieldsArgs<'_>) -> Result<Vec<Field>>
Return the fields used to store the intermediate state of this accumulator. Read more
source§fn accumulator(
&self,
_acc_args: AccumulatorArgs<'_>,
) -> Result<Box<dyn Accumulator>>
fn accumulator( &self, _acc_args: AccumulatorArgs<'_>, ) -> Result<Box<dyn Accumulator>>
Return a new
Accumulator
that aggregates values for a specific
group during query execution. Read moresource§fn aliases(&self) -> &[String]
fn aliases(&self) -> &[String]
Returns any aliases (alternate names) for this function. Read more
source§fn create_groups_accumulator(
&self,
_args: AccumulatorArgs<'_>,
) -> Result<Box<dyn GroupsAccumulator>>
fn create_groups_accumulator( &self, _args: AccumulatorArgs<'_>, ) -> Result<Box<dyn GroupsAccumulator>>
Return a specialized
GroupsAccumulator
that manages state
for all groups. Read moresource§fn reverse_expr(&self) -> ReversedUDAF
fn reverse_expr(&self) -> ReversedUDAF
Returns the reverse expression of the aggregate function.
source§fn is_descending(&self) -> Option<bool>
fn is_descending(&self) -> Option<bool>
If this function is max, return true
if the function is min, return false
otherwise return None (the default) 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_sliding_accumulator(
&self,
args: AccumulatorArgs<'_>,
) -> Result<Box<dyn Accumulator>>
fn create_sliding_accumulator( &self, args: AccumulatorArgs<'_>, ) -> Result<Box<dyn Accumulator>>
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>>>
fn with_beneficial_ordering( self: Arc<Self>, _beneficial_ordering: bool, ) -> Result<Option<Arc<dyn AggregateUDFImpl>>>
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<AggregateFunctionSimplification>
fn simplify(&self) -> Option<AggregateFunctionSimplification>
Optionally apply per-UDaF simplification / rewrite rules. Read more
source§fn coerce_types(&self, _arg_types: &[DataType]) -> Result<Vec<DataType>>
fn coerce_types(&self, _arg_types: &[DataType]) -> Result<Vec<DataType>>
Coerce arguments of a function call to types that the function can evaluate. Read more
source§fn equals(&self, other: &dyn AggregateUDFImpl) -> bool
fn equals(&self, other: &dyn AggregateUDFImpl) -> bool
Return true if this aggregate UDF is equal to the other. Read more
source§fn hash_value(&self) -> u64
fn hash_value(&self) -> u64
Returns a hash value for this aggregate UDF. Read more
Auto Trait Implementations§
impl Freeze for Max
impl RefUnwindSafe for Max
impl Send for Max
impl Sync for Max
impl Unpin for Max
impl UnwindSafe for Max
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