Struct sea_query::query::Search

pub struct Search { /* private fields */ }

For recursive WithQuery WithClauses the traversing order can be specified in some databases that support this functionality.

The clause contains the type of traversal: SearchOrder and the expression that is used to construct the current path.

A query can have both SEARCH and CYCLE clauses.

Setting Self::order and Self::expr is mandatory. The SelectExpr used must specify an alias which will be the name that you can use to order the result of the CommonTableExpression.

Implementations

impl Search

pub fn new_from_order_and_expr<EXPR>(order: SearchOrder, expr: EXPR) -> Self

where EXPR: Into<SelectExpr>,

Create a complete Search specification from the SearchOrder and a SelectExpr. The given SelectExpr must have an alias specified.

pub fn new() -> Self

Constructs a new empty Search.

pub fn order(&mut self, order: SearchOrder) -> &mut Self

The traversal order to be used.

pub fn expr<EXPR>(&mut self, expr: EXPR) -> &mut Self

where EXPR: Into<SelectExpr>,

The given SelectExpr must have an alias specified.

The actual expression will be the one used to track the path in the graph.

The alias of the given SelectExpr will be the name of the order column generated by this clause.

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Search

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

Formats the value using the given formatter.

impl Default for Search

fn default() -> Search

Returns the “default value” for a type.

impl PartialEq for Search

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

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

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.

impl StructuralPartialEq for Search