pub struct Cursor<S>where
S: SelectorTrait,{ /* private fields */ }
Expand description
Cursor pagination
Implementations§
source§impl<S> Cursor<S>where
S: SelectorTrait,
impl<S> Cursor<S>where S: SelectorTrait,
sourcepub fn new<C>(query: SelectStatement, table: DynIden, order_columns: C) -> Selfwhere
C: IntoIdentity,
pub fn new<C>(query: SelectStatement, table: DynIden, order_columns: C) -> Selfwhere C: IntoIdentity,
Initialize a cursor
sourcepub fn before<V>(&mut self, values: V) -> &mut Selfwhere
V: IntoValueTuple,
pub fn before<V>(&mut self, values: V) -> &mut Selfwhere V: IntoValueTuple,
Filter paginated result with corresponding column less than the input value
sourcepub fn after<V>(&mut self, values: V) -> &mut Selfwhere
V: IntoValueTuple,
pub fn after<V>(&mut self, values: V) -> &mut Selfwhere V: IntoValueTuple,
Filter paginated result with corresponding column greater than the input value
sourcepub fn first(&mut self, num_rows: u64) -> &mut Self
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
sourcepub fn last(&mut self, num_rows: u64) -> &mut Self
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
sourcepub async fn all<C>(&mut self, db: &C) -> Result<Vec<S::Item>, DbErr>where
C: ConnectionTrait,
pub async fn all<C>(&mut self, db: &C) -> Result<Vec<S::Item>, DbErr>where C: ConnectionTrait,
Fetch the paginated result
sourcepub fn into_model<M>(self) -> Cursor<SelectModel<M>>where
M: FromQueryResult,
pub fn into_model<M>(self) -> Cursor<SelectModel<M>>where M: FromQueryResult,
Construct a Cursor that fetch any custom struct
sourcepub fn into_partial_model<M>(self) -> Cursor<SelectModel<M>>where
M: PartialModelTrait,
pub fn into_partial_model<M>(self) -> Cursor<SelectModel<M>>where M: PartialModelTrait,
Return a [Selector] from Self
that wraps a SelectModel with a PartialModel
Trait Implementations§
source§impl<S> QueryOrder for Cursor<S>where
S: SelectorTrait,
impl<S> QueryOrder for Cursor<S>where S: SelectorTrait,
type QueryStatement = SelectStatement
source§fn query(&mut self) -> &mut SelectStatement
fn query(&mut self) -> &mut SelectStatement
Add the query to perform an ORDER BY operation
source§fn order_by<C>(self, col: C, ord: Order) -> Selfwhere
C: IntoSimpleExpr,
fn order_by<C>(self, col: C, ord: Order) -> Selfwhere C: IntoSimpleExpr,
Add an order_by expression Read more
source§fn order_by_asc<C>(self, col: C) -> Selfwhere
C: IntoSimpleExpr,
fn order_by_asc<C>(self, col: C) -> Selfwhere C: IntoSimpleExpr,
Add an order_by expression (ascending) Read more
source§fn order_by_desc<C>(self, col: C) -> Selfwhere
C: IntoSimpleExpr,
fn order_by_desc<C>(self, col: C) -> Selfwhere C: IntoSimpleExpr,
Add an order_by expression (descending) Read more
source§impl<S> QuerySelect for Cursor<S>where
S: SelectorTrait,
impl<S> QuerySelect for Cursor<S>where S: SelectorTrait,
type QueryStatement = SelectStatement
source§fn query(&mut self) -> &mut SelectStatement
fn query(&mut self) -> &mut SelectStatement
Add the select SQL statement
source§fn select_only(self) -> Self
fn select_only(self) -> Self
Clear the selection list
source§fn column<C>(self, col: C) -> Selfwhere
C: ColumnTrait,
fn column<C>(self, col: C) -> Selfwhere C: ColumnTrait,
Add a select column Read more
source§fn column_as<C, I>(self, col: C, alias: I) -> Selfwhere
C: IntoSimpleExpr,
I: IntoIdentity,
fn column_as<C, I>(self, col: C, alias: I) -> Selfwhere C: IntoSimpleExpr, I: IntoIdentity,
Add a select column with alias Read more
source§fn columns<C, I>(self, cols: I) -> Selfwhere
C: ColumnTrait,
I: IntoIterator<Item = C>,
fn columns<C, I>(self, cols: I) -> Selfwhere C: ColumnTrait, I: IntoIterator<Item = C>,
Select columns Read more
source§fn offset<T>(self, offset: T) -> Selfwhere
T: Into<Option<u64>>,
fn offset<T>(self, offset: T) -> Selfwhere T: Into<Option<u64>>,
Add an offset expression. Passing in None would remove the offset. Read more
source§fn limit<T>(self, limit: T) -> Selfwhere
T: Into<Option<u64>>,
fn limit<T>(self, limit: T) -> Selfwhere T: Into<Option<u64>>,
Add a limit expression. Passing in None would remove the limit. Read more
source§fn group_by<C>(self, col: C) -> Selfwhere
C: IntoSimpleExpr,
fn group_by<C>(self, col: C) -> Selfwhere C: IntoSimpleExpr,
Add a group by column Read more
source§fn having<F>(self, filter: F) -> Selfwhere
F: IntoCondition,
fn having<F>(self, filter: F) -> Selfwhere F: IntoCondition,
Add an AND HAVING expression Read more
source§fn distinct_on<T, I>(self, cols: I) -> Selfwhere
T: IntoColumnRef,
I: IntoIterator<Item = T>,
fn distinct_on<T, I>(self, cols: I) -> Selfwhere T: IntoColumnRef, I: IntoIterator<Item = T>,
Add a DISTINCT ON expression
NOTE: this function is only supported by
sqlx-postgres
Read moresource§fn join(self, join: JoinType, rel: RelationDef) -> Self
fn join(self, join: JoinType, rel: RelationDef) -> Self
Join via
RelationDef
.source§fn join_rev(self, join: JoinType, rel: RelationDef) -> Self
fn join_rev(self, join: JoinType, rel: RelationDef) -> Self
Join via
RelationDef
but in reverse direction.
Assume when there exist a relation A to B.
You can reverse join B from A.source§fn join_as<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Selfwhere
I: IntoIden,
fn join_as<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Selfwhere I: IntoIden,
Join via
RelationDef
with table alias.source§fn join_as_rev<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Selfwhere
I: IntoIden,
fn join_as_rev<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Selfwhere I: IntoIden,
Join via
RelationDef
with table alias but in reverse direction.
Assume when there exist a relation A to B.
You can reverse join B from A.Select lock shared
source§fn lock_exclusive(self) -> Self
fn lock_exclusive(self) -> Self
Select lock exclusive
Auto Trait Implementations§
impl<S> !RefUnwindSafe for Cursor<S>
impl<S> Send for Cursor<S>where S: Send,
impl<S> Sync for Cursor<S>where S: Sync,
impl<S> Unpin for Cursor<S>where S: Unpin,
impl<S> !UnwindSafe for Cursor<S>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<S> SelectColumns for Swhere
S: QuerySelect,
impl<S> SelectColumns for Swhere S: QuerySelect,
source§fn select_column<C>(self, col: C) -> Swhere
C: ColumnTrait,
fn select_column<C>(self, col: C) -> Swhere C: ColumnTrait,
Add a select column Read more
source§fn select_column_as<C, I>(self, col: C, alias: I) -> Swhere
C: IntoSimpleExpr,
I: IntoIdentity,
fn select_column_as<C, I>(self, col: C, alias: I) -> Swhere C: IntoSimpleExpr, I: IntoIdentity,
Add a select column with alias Read more