Struct Window 

pub struct Window {
    pub input: Arc<LogicalPlan>,
    pub window_expr: Vec<Expr>,
    pub schema: DFSchemaRef,
}

Window its input based on a set of window spec and window function (e.g. SUM or RANK)

Output Schema

The output schema is the input schema followed by the window function expressions, in order.

For example, given the input schema "A", "B", "C" and the window function SUM(A) OVER (PARTITION BY B+1 ORDER BY C), the output schema will be "A", "B", "C", "SUM(A) OVER ..." where "SUM(A) OVER ..." is the name of the output column.

Note that the PARTITION BY expression “B+1” is not produced in the output schema.

Fields

input: Arc<LogicalPlan>

The incoming logical plan

window_expr: Vec<Expr>

The window function expression

schema: DFSchemaRef

The schema description of the window output

Implementations

impl Window

pub fn try_new(window_expr: Vec<Expr>, input: Arc<LogicalPlan>) -> Result<Self>

Create a new window operator.

pub fn try_new_with_schema( window_expr: Vec<Expr>, input: Arc<LogicalPlan>, schema: DFSchemaRef, ) -> Result<Self>

Create a new window function using the provided schema to avoid the overhead of building the schema again when the schema is already known.

This method should only be called when you are absolutely sure that the schema being provided is correct for the window function. If in doubt, call try_new instead.

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Window

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

Formats the value using the given formatter.

impl Hash for Window

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 Window

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

fn partial_cmp(&self, other: &Self) -> 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 Eq for Window

impl StructuralPartialEq for Window