Struct SortField 

pub struct SortField {
    pub sort_key_index: i32,
    pub expression: String,
    pub dialect: String,
    pub direction: SortDirection,
    pub null_order: NullOrder,
}

One key of a sort spec: an expression to sort by, plus direction and null order.

The key is an expression string (ducklake_sort_expression.expression), not a column_id — DuckLake sort keys are expression-based. For a spec this crate produced, expression is a bare column name; for a spec written by DuckDB it may be any expression, in which case SortField::column_candidate returns None and the write path rejects the unsupported sort contract.

Fields

sort_key_index: i32

0-based position of this key within the sort order.

expression: String

The sort expression (ducklake_sort_expression.expression).

dialect: String

The expression dialect (ducklake_sort_expression.dialect), e.g. "duckdb".

direction: SortDirection

Ascending or descending.

null_order: NullOrder

Where nulls sort.

Implementations

impl SortField

pub fn column( sort_key_index: i32, column: impl Into<String>, direction: SortDirection, null_order: NullOrder, ) -> Self

Build a bare-column sort field this crate can produce. expression is the column name; dialect is set to DUCKDB_DIALECT.

pub fn column_candidate(&self) -> Option<String>

Interpret this key’s expression as a bare column reference, returning the column name if it is one. A bare column is either an unquoted simple identifier (ts, device_id) or a double-quoted identifier ("My Col", unquoted here). Anything else — function calls, arithmetic, qualified names, multiple tokens — yields None.

Trait Implementations

impl Clone for SortField

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SortField

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

Formats the value using the given formatter.

impl Eq for SortField

impl PartialEq for SortField

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SortField