Struct SimpleWindowUDF

pub struct SimpleWindowUDF { /* private fields */ }

Implements WindowUDFImpl for functions that have a single signature and return type.

Implementations

impl SimpleWindowUDF

pub fn new( name: impl Into<String>, input_type: DataType, return_type: DataType, volatility: Volatility, partition_evaluator_factory: PartitionEvaluatorFactory, ) -> Self

Create a new SimpleWindowUDF from a name, input types, return type and implementation. Implementing WindowUDFImpl allows more flexibility

Trait Implementations

impl Debug for SimpleWindowUDF

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

Formats the value using the given formatter.

impl WindowUDFImpl for SimpleWindowUDF

fn as_any(&self) -> &dyn Any

Returns this object as an Any trait object

fn name(&self) -> &str

Returns this function’s name

fn signature(&self) -> &Signature

Returns the function’s Signature for information about what input types are accepted and the function’s Volatility.

fn partition_evaluator( &self, _partition_evaluator_args: PartitionEvaluatorArgs<'_>, ) -> Result<Box<dyn PartitionEvaluator>>

Invoke the function, returning the PartitionEvaluator instance

fn field(&self, field_args: WindowUDFFieldArgs<'_>) -> Result<Field>

The Field of the final result of evaluating this window function.

fn expressions( &self, expr_args: ExpressionArgs<'_>, ) -> Vec<Arc<dyn PhysicalExpr>>

Returns the expressions that are passed to the PartitionEvaluator.

fn aliases(&self) -> &[String]

Returns any aliases (alternate names) for this function.

fn simplify(&self) -> Option<WindowFunctionSimplification>

Optionally apply per-UDWF simplification / rewrite rules.

fn equals(&self, other: &dyn WindowUDFImpl) -> bool

Return true if this window UDF is equal to the other.

fn hash_value(&self) -> u64

Returns a hash value for this window UDF.

fn sort_options(&self) -> Option<SortOptions>

Allows the window UDF to define a custom result ordering.

fn coerce_types(&self, _arg_types: &[DataType]) -> Result<Vec<DataType>>

Coerce arguments of a function call to types that the function can evaluate.

fn reverse_expr(&self) -> ReversedUDWF

Allows customizing the behavior of the user-defined window function when it is evaluated in reverse order.

fn documentation(&self) -> Option<&Documentation>

Returns the documentation for this Window UDF.