Struct SortColumn 

pub struct SortColumn {
    pub name: String,
    pub descending: bool,
    pub nulls_first: bool,
}

Declares a column’s sort ordering for a streaming source.

When a source declares output ordering, DataFusion can elide unnecessary SortExec nodes from the physical plan, enabling ORDER BY queries on pre-sorted unbounded streams.

Example

// Source sorted by event_time ascending
let ordering = vec![SortColumn {
    name: "event_time".to_string(),
    descending: false,
    nulls_first: false,
}];

Fields

name: String

Column name to sort by

descending: bool

Whether the sort is descending (false = ascending)

nulls_first: bool

Whether nulls sort first (before non-null values)

Implementations

impl SortColumn

pub fn ascending(name: impl Into<String>) -> Self

Creates a new ascending sort column with nulls last.

pub fn descending(name: impl Into<String>) -> Self

Creates a new descending sort column with nulls last.

pub fn with_nulls_first(self, nulls_first: bool) -> Self

Sets whether nulls sort first.

Trait Implementations

impl Clone for SortColumn

fn clone(&self) -> SortColumn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SortColumn

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

Formats the value using the given formatter.

impl PartialEq for SortColumn

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

impl StructuralPartialEq for SortColumn