Struct WindowFunction 

pub struct WindowFunction {
    pub fun: WindowFunctionDefinition,
    pub params: WindowFunctionParams,
}

Window function

Holds the actual function to call WindowFunction as well as its arguments (args) and the contents of the OVER clause:

1. PARTITION BY
2. ORDER BY
3. Window frame (e.g. ROWS 1 PRECEDING AND 1 FOLLOWING)

See ExprFunctionExt for examples of how to create a WindowFunction.

Fields

fun: WindowFunctionDefinition

Name of the function

params: WindowFunctionParams

Implementations

impl WindowFunction

pub fn new( fun: impl Into<WindowFunctionDefinition>, args: Vec<Expr>, ) -> WindowFunction

Create a new Window expression with the specified argument an empty OVER clause

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

Returns this window function’s simplification hook, if any.

See WindowFunctionSimplification for more information

Trait Implementations

impl Clone for WindowFunction

fn clone(&self) -> WindowFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowFunction

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

Formats the value using the given formatter.

impl Eq for WindowFunction

impl From<WindowFunction> for Expr

Create an Expr from a WindowFunction

fn from(value: WindowFunction) -> Expr

Converts to this type from the input type.

impl Hash for WindowFunction

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 WindowFunction

fn eq(&self, other: &WindowFunction) -> 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 PartialOrd for WindowFunction

fn partial_cmp(&self, other: &WindowFunction) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for WindowFunction