Struct WindowSpec 

pub struct WindowSpec<'a, V: SQLParam, S = ()> { /* private fields */ }

The contents of an OVER (...) clause; start one with window.

S records the tables that PARTITION BY and ORDER BY read, for the query’s scope check.

Examples

let spec = window()
    .partition_by([users.name])
    .order_by(asc(users.created_at))
    .rows_between(FrameBound::UnboundedPreceding, FrameBound::CurrentRow);
let total = sum(users.score).over(spec);
assert_eq!(
    total.sql(),
    r#"SUM ("users"."score") OVER (PARTITION BY "users"."name" ORDER BY "users"."created_at" ASC ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)"#
);

Implementations

impl<'a, V: SQLParam + 'a, S> WindowSpec<'a, V, S>

pub fn partition_by<I>( self, exprs: I, ) -> WindowSpec<'a, V, (S, ScopeOnly<<I::Item as ExprSources>::Sources>)>

where I: IntoIterator, I::Item: ToSQL<'a, V> + ExprSources,

Sets PARTITION BY; the window restarts for each distinct value.

Takes an array or other iterator of expressions of one Rust type.

pub fn order_by<T: ToSQL<'a, V> + ExprSources>( self, exprs: T, ) -> WindowSpec<'a, V, (S, ScopeOnly<T::Sources>)>

Sets ORDER BY inside the window.

Takes one ordering term such as asc(col), or a tuple or array of terms.

pub fn rows_between(self, start: FrameBound, end: FrameBound) -> Self

Sets a ROWS BETWEEN start AND end frame, counted in rows.

pub fn range_between(self, start: FrameBound, end: FrameBound) -> Self

Sets a RANGE BETWEEN start AND end frame, measured in ORDER BY values.

Trait Implementations

impl<'a, V: Clone + SQLParam, S: Clone> Clone for WindowSpec<'a, V, S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, V: Debug + SQLParam, S: Debug> Debug for WindowSpec<'a, V, S>

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

Formats the value using the given formatter.