Struct PythonFunctionWindowUDF 

pub struct PythonFunctionWindowUDF { /* private fields */ }

WindowUDFImpl for Python-defined window UDFs.

Holds the Python evaluator factory directly so the codec can downcast and cloudpickle it across process boundaries. Replaces the prior factory-erased MultiColumnWindowUDF; the old name is kept as a type alias below for backward compatibility.

Implementations

impl PythonFunctionWindowUDF

pub fn new( name: impl Into<String>, evaluator: Py<PyAny>, input_types: Vec<DataType>, return_type: DataType, volatility: Volatility, ) -> Self

Trait Implementations

impl Debug for PythonFunctionWindowUDF

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

Formats the value using the given formatter.

impl Eq for PythonFunctionWindowUDF

impl Hash for PythonFunctionWindowUDF

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 PythonFunctionWindowUDF

fn eq(&self, other: &Self) -> 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 WindowUDFImpl for PythonFunctionWindowUDF

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 field(&self, field_args: WindowUDFFieldArgs<'_>) -> Result<FieldRef>

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

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

Invoke the function, returning the PartitionEvaluator instance

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

Returns any aliases (alternate names) for this function.

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

Returns the expressions that are passed to the PartitionEvaluator.

fn simplify( &self, ) -> Option<Box<dyn Fn(WindowFunction, &SimplifyContext) -> Result<Expr, DataFusionError>>>

Returns an optional hook for simplifying this user-defined window function.

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>, DataFusionError>

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.

fn limit_effect(&self, _args: &[Arc<dyn PhysicalExpr>]) -> LimitEffect

If not causal, returns the effect this function will have on the window