Struct OrderDef 

pub struct OrderDef {
    pub expression: Option<Expr>,
    pub collation: Option<Cow<'static, str>>,
    pub direction: Option<OrderDirection>,
    pub nulls: Option<NullsPosition>,
}

One sort key: expr [COLLATE c] [ASC | DESC | USING op] [NULLS FIRST | LAST].

From PostgreSQL 17:

ORDER BY expression [ ASC | DESC | USING operator ] [ NULLS { FIRST | LAST } ]

COLLATE is formally part of the expression rather than of the sort key, but it has to be written between the expression and the direction, so it lives here.

Fields

expression: Option<Expr>

What to sort by.

collation: Option<Cow<'static, str>>

A collation name, quoted on output.

direction: Option<OrderDirection>

Ascending, descending, or by an operator.

nulls: Option<NullsPosition>

Where nulls sort. Defaults, in every dialect, to whichever end the direction puts last.

Implementations

impl OrderDef

pub fn new(expression: impl IntoExpr) -> Self

A sort key with no modifiers.

pub fn is_empty(&self) -> bool

Whether there is nothing to sort by.

Trait Implementations

impl Clone for OrderDef

fn clone(&self) -> OrderDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderDef

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

Formats the value using the given formatter.

impl Default for OrderDef

fn default() -> OrderDef

Returns the “default value” for a type.

impl Expression for OrderDef

fn write_sql(&self, w: &mut SqlWriter<'_>)

Append this fragment to w.