Struct OrderByClause 

pub struct OrderByClause {
    pub field: String,
    pub direction: OrderDirection,
    pub field_type: OrderByFieldType,
    pub native_column: Option<String>,
}

ORDER BY clause with optional type and native column information.

The SQL generator uses field_type to emit the correct type cast for JSONB-extracted values, and native_column to bypass JSONB extraction entirely when the view exposes a dedicated typed column.

Sort correctness by source

Source	Text fields	Numeric fields	Date fields
JSONB (no cast)	Correct	Wrong (lexicographic)	Correct (ISO-8601)
JSONB (with cast)	Correct	Correct	Correct
Native column	Correct	Correct	Correct + indexable

Fields

field: String

Field to order by (GraphQL camelCase name).

direction: OrderDirection

Sort direction.

field_type: OrderByFieldType

Field type for SQL cast generation. Text (default) means no cast.

native_column: Option<String>

Native column name if the view exposes this field as a typed column. When set, ORDER BY uses this column directly instead of JSONB extraction, enabling index support and correct typing without casts.

Implementations

impl OrderByClause

pub fn new(field: String, direction: OrderDirection) -> OrderByClause

Create a new OrderByClause with default field type (text) and no native column.

pub fn storage_key(&self) -> String

Convert the GraphQL camelCase field name to the JSONB snake_case storage key.

Examples

use fraiseql_db::OrderByClause;
use fraiseql_db::OrderDirection;

let clause = OrderByClause::new("createdAt".to_string(), OrderDirection::Asc);
assert_eq!(clause.storage_key(), "created_at");

pub fn validate_field_name(field: &str) -> Result<(), FraiseQLError>

Validate that a field name matches the GraphQL identifier pattern [_A-Za-z][_0-9A-Za-z]*.

This is a security boundary: field names are interpolated into SQL data->>'field' expressions. Any character outside the GraphQL identifier set must be rejected before the OrderByClause is constructed.

Errors

Returns FraiseQLError::Validation if the field contains invalid characters.

pub fn from_graphql_json( value: &Value, ) -> Result<Vec<OrderByClause>, FraiseQLError>

Parse orderBy from a GraphQL variables JSON value.

Accepts two formats:

• Object: { "name": "DESC", "created_at": "ASC" }
• Array: [{ "field": "name", "direction": "DESC" }]

Direction strings are case-insensitive.

Errors

Returns FraiseQLError::Validation for invalid structure or direction values.

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderByClause

fn deserialize<__D>( __deserializer: __D, ) -> Result<OrderByClause, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderByClause

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OrderByClause

impl StructuralPartialEq for OrderByClause