pub struct PhysicalSortRequirement {
    pub expr: Arc<dyn PhysicalExpr>,
    pub options: Option<SortOptions>,
}
Expand description

Represents sort requirement associated with a plan

If the requirement includes SortOptions then both the expression and the sort options must match.

If the requirement does not include SortOptions) then only the expressions must match.

Examples

With sort options (A, DESC NULLS FIRST):

  • ORDER BY A DESC NULLS FIRST matches
  • ORDER BY A ASC NULLS FIRST does not match (ASC vs DESC)
  • ORDER BY B DESC NULLS FIRST does not match (different expr)

Without sort options (A, None):

  • ORDER BY A DESC NULLS FIRST matches
  • ORDER BY A ASC NULLS FIRST matches (ASC and NULL options ignored)
  • ORDER BY B DESC NULLS FIRST does not match (different expr)

Fields§

§expr: Arc<dyn PhysicalExpr>

Physical expression representing the column to sort

§options: Option<SortOptions>

Option to specify how the given column should be sorted. If unspecified, there are no constraints on sort options.

Implementations§

source§

impl PhysicalSortRequirement

source

pub fn new(expr: Arc<dyn PhysicalExpr>, options: Option<SortOptions>) -> Self

Creates a new requirement.

If options is Some(..), creates an exact requirement, which must match both options and expr.

If options is None, Creates a new expr_only requirement, which must match only expr.

See PhysicalSortRequirement for examples.

source

pub fn with_expr(self, expr: Arc<dyn PhysicalExpr>) -> Self

Replace the required expression for this requirement with the new one

source

pub fn compatible(&self, other: &PhysicalSortRequirement) -> bool

Returns whether this requirement is equal or more specific than other.

source

pub fn from_sort_exprs<'a>( ordering: impl IntoIterator<Item = &'a PhysicalSortExpr> ) -> Vec<PhysicalSortRequirement>

Returns PhysicalSortRequirement that requires the exact sort of the PhysicalSortExprs in ordering

This method takes &'a PhysicalSortExpr to make it easy to use implementing ExecutionPlan::required_input_ordering.

source

pub fn to_sort_exprs( requirements: impl IntoIterator<Item = PhysicalSortRequirement> ) -> Vec<PhysicalSortExpr>

Converts an iterator of PhysicalSortRequirement into a Vec of PhysicalSortExprs.

This function converts PhysicalSortRequirement to PhysicalSortExpr for each entry in the input. If required ordering is None for an entry default ordering ASC, NULLS LAST if given (see the PhysicalSortExpr::from).

Trait Implementations§

source§

impl Clone for PhysicalSortRequirement

source§

fn clone(&self) -> PhysicalSortRequirement

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PhysicalSortRequirement

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for PhysicalSortRequirement

source§

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

Formats the value using the given formatter. Read more
source§

impl From<PhysicalSortExpr> for PhysicalSortRequirement

source§

fn from(value: PhysicalSortExpr) -> Self

Converts to this type from the input type.
source§

impl From<PhysicalSortRequirement> for PhysicalSortExpr

source§

fn from(value: PhysicalSortRequirement) -> Self

If options is None, the default sort options ASC, NULLS LAST is used.

The default is picked to be consistent with PostgreSQL: https://www.postgresql.org/docs/current/queries-order.html

source§

impl PartialEq<PhysicalSortRequirement> for PhysicalSortRequirement

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V