Struct OrderByClause 

pub struct OrderByClause {
    pub field: String,
    pub field_source: FieldSource,
    pub direction: SortOrder,
    pub collation: Option<String>,
    pub nulls_handling: Option<NullsHandling>,
}

Represents a complete ORDER BY clause

Supports:

• Both JSONB fields and direct columns
• PostgreSQL collations
• NULLS FIRST/LAST handling
• Mixed multi-field ordering

Examples

use fraiseql_wire::operators::{OrderByClause, FieldSource, SortOrder, NullsHandling};

// Order by JSONB field with collation
let _ = OrderByClause {
    field: "name".to_string(),
    field_source: FieldSource::JsonbPayload,
    direction: SortOrder::Asc,
    collation: Some("en-US".to_string()),
    nulls_handling: None,
};

// Order by direct column with NULLS LAST
let _ = OrderByClause {
    field: "created_at".to_string(),
    field_source: FieldSource::DirectColumn,
    direction: SortOrder::Desc,
    collation: None,
    nulls_handling: Some(NullsHandling::Last),
};

Fields

field: String

Field name (validated separately based on field_source)

field_source: FieldSource

Where the field comes from

direction: SortOrder

Sort direction

collation: Option<String>

Optional collation name (e.g., “en-US”, “C”, “de_DE.UTF-8”)

When specified, generates: field COLLATE "collation_name"

nulls_handling: Option<NullsHandling>

Optional NULLS handling

Implementations

impl OrderByClause

pub fn jsonb_field(field: impl Into<String>, direction: SortOrder) -> Self

Create a new ORDER BY clause for a JSONB field

pub fn direct_column(field: impl Into<String>, direction: SortOrder) -> Self

Create a new ORDER BY clause for a direct column

pub fn with_collation(self, collation: impl Into<String>) -> Self

Add collation to this clause

pub const fn with_nulls(self, handling: NullsHandling) -> Self

Add NULLS handling to this clause

pub fn validate(&self) -> Result<(), String>

Validate field name to prevent SQL injection

Errors

Returns an error string if the field name is empty, contains invalid characters, or the collation name (if set) contains invalid characters.

pub fn to_sql(&self) -> Result<String, String>

Generate SQL for this clause

Examples

• JSONB with collation: (data->'name') COLLATE "en-US" ASC
• Direct column: created_at DESC
• With NULLS: status ASC NULLS LAST

Errors

Returns an error string if the clause fails validation (see Self::validate).

Trait Implementations

impl Clone for OrderByClause

fn clone(&self) -> OrderByClause

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderByClause

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

Formats the value using the given formatter.

impl Display for OrderByClause

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

Formats the value using the given formatter.