Struct ReplaceSortOrderAction 

pub struct ReplaceSortOrderAction { /* private fields */ }

Transaction action for replacing sort order.

Implementations

impl ReplaceSortOrderAction

pub fn asc(self, name: &str, null_order: NullOrder) -> Self

Adds a field for sorting in ascending order, sorting by the column’s raw value (an identity transform). To sort by a transform of the column instead (e.g. bucket[N], year, truncate[W]), use Self::asc_with_transform.

pub fn desc(self, name: &str, null_order: NullOrder) -> Self

Adds a field for sorting in descending order, sorting by the column’s raw value (an identity transform). To sort by a transform of the column instead (e.g. bucket[N], year, truncate[W]), use Self::desc_with_transform.

pub fn asc_with_transform( self, name: &str, transform: Transform, null_order: NullOrder, ) -> Self

Adds a field for sorting in ascending order by a transform of the column’s value (e.g. Transform::Bucket(16), Transform::Year, Transform::Truncate(4)).

Whether the transform is valid for the column’s type is checked at commit time, once the table schema is available (mirroring Java’s SortOrder.Builder.build()). Transform::Unknown and Transform::Void are rejected at commit time with ErrorKind::DataInvalid. Rejecting Void is an intentional authoring policy for this action: an all-null sort key adds no ordering information.

Note: Term is currently a plain column reference. Once it becomes transform-carrying (#2665), sort-order declaration is expected to converge on Term-based asc/desc (as in Java’s SortOrderBuilder), at which point the _with_transform variants can be deprecated in its favor.

pub fn desc_with_transform( self, name: &str, transform: Transform, null_order: NullOrder, ) -> Self

Adds a field for sorting in descending order by a transform of the column’s value.

See Self::asc_with_transform for validation and future API direction.