Struct sea_orm::Cursor

pub struct Cursor<S>where
    S: SelectorTrait,{ /* private fields */ }

Cursor pagination

Implementations

impl<S> Cursor<S>where
    S: SelectorTrait,

pub fn new<C>(query: SelectStatement, table: DynIden, order_columns: C) -> Selfwhere
    C: IntoIdentity,

Initialize a cursor

pub fn before<V>(&mut self, values: V) -> &mut Selfwhere
    V: IntoValueTuple,

Filter paginated result with corresponding column less than the input value

pub fn after<V>(&mut self, values: V) -> &mut Selfwhere
    V: IntoValueTuple,

Filter paginated result with corresponding column greater than the input value

pub fn first(&mut self, num_rows: u64) -> &mut Self

Limit result set to only first N rows in ascending order of the order by column

pub fn last(&mut self, num_rows: u64) -> &mut Self

Limit result set to only last N rows in ascending order of the order by column

pub async fn all<C>(&mut self, db: &C) -> Result<Vec<S::Item>, DbErr>where
    C: ConnectionTrait,

Fetch the paginated result

pub fn into_model<M>(self) -> Cursor<SelectModel<M>>where
    M: FromQueryResult,

Construct a Cursor that fetch any custom struct

pub fn into_json(self) -> Cursor<SelectModel<JsonValue>>

Construct a Cursor that fetch JSON value

Trait Implementations

impl<S> Clone for Cursor<S>where
    S: SelectorTrait + Clone,

fn clone(&self) -> Cursor<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Cursor<S>where
    S: SelectorTrait + Debug,

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

Formats the value using the given formatter.

impl<S> QueryOrder for Cursor<S>where
    S: SelectorTrait,

type QueryStatement = SelectStatement

fn query(&mut self) -> &mut SelectStatement

Add the query to perform an ORDER BY operation

fn order_by<C>(self, col: C, ord: Order) -> Selfwhere
    C: IntoSimpleExpr,

Add an order_by expression

fn order_by_asc<C>(self, col: C) -> Selfwhere
    C: IntoSimpleExpr,

Add an order_by expression (ascending)

fn order_by_desc<C>(self, col: C) -> Selfwhere
    C: IntoSimpleExpr,

Add an order_by expression (descending)