Struct Condition 

pub struct Condition {
    pub page: Option<PaginationParam>,
    pub cond: Condition,
    pub order: Vec<(SimpleExpr, Order)>,
}

Available on crate features api and seaorm only.

The query condition hub: filters + optional pagination + sort order.

Built fluently, then applied to a SeaORM Select via Condition::build or executed directly with Condition::select_page. All CRUD helpers generated by the default_repo macro funnel through it.

Fields

page: Option<PaginationParam>

Optional SQL pagination.

cond: Condition

WHERE filters, all() by default.

order: Vec<(SimpleExpr, Order)>

Sort expressions, applied in insertion order.

Implementations

impl Condition

pub fn new(cond: Condition) -> Self

Wrap an existing sea_orm::Condition as filters.

pub fn new_all() -> Self

New condition matching everything (all()).

pub fn new_any() -> Self

New condition matching anything (any()).

pub fn add_sort(self, col: SimpleExpr, sort: Order) -> Self

Append one sort expression; later calls take precedence for ties.

pub fn add_page(self, page: PaginationParam) -> Self

Attach SQL pagination.

pub fn parse_sort_option( self, str: &Option<String>, col: Vec<ColumnRef>, ) -> Self

Parse the sort string when present, see Condition::parse_sort.

pub fn parse_sort(self, str: &str, col: Vec<ColumnRef>) -> Self

Parse a sort string like -created_at,+name into sort expressions.

-/+ prefixes select descending/ascending order (no prefix = ascending); names not present in the col whitelist are silently ignored, so this is safe to feed straight from user input.

pub fn any() -> Condition

Shortcut of sea_orm::Condition::any.

pub fn all() -> Condition

Shortcut of sea_orm::Condition::all.

pub fn add<C>(self, condition: C) -> Self

where C: Into<Condition>,

AND one more condition.

pub fn add_option<C>(self, condition: Option<C>) -> Self

where C: Into<Condition>,

AND one more condition, ignored when None.

pub fn build<E>(self, q: Select<E>) -> (Select<E>, Option<PaginationParam>)

where E: EntityTrait,

Apply the sort order and filters to a Select.

Returns the built query together with the detached pagination, ready for SelectPage::select_page.

pub async fn select_page<M, E, C>( self, q: Select<E>, db: &C, ) -> Result<(Vec<E::Model>, u64)>

where E: EntityTrait<Model = M>, M: FromQueryResult + Sized + Send + Sync, C: ConnectionTrait,

Condition::build + SelectPage::select_page in one call; returns (items, total_count).

pub fn add_time<T>(self, p: &TimeParam) -> Self

where T: DefaultColumnTrait,

Available on crate feature entity only.

Add created/updated time range filters from TimeParam, using the columns provided by DefaultColumnTrait (usually implemented by the entity_timestamp macro).

Trait Implementations

impl Default for Condition

fn default() -> Self

Returns the “default value” for a type.

impl From<Condition> for Condition

fn from(cond: Condition) -> Self

Converts to this type from the input type.