Skip to main content

EntityQuery

Struct EntityQuery 

Source
pub struct EntityQuery<T, E: EntityTrait> { /* private fields */ }
Expand description

A chainable query builder that wraps SeaORM’s Select<E> and auto-converts results to the domain type T via From<E::Model>.

Construct one from E::find() or E::find_by_id(pk) and then chain filter/order/limit/offset calls before executing with a terminal method.

§Example

let todos: Vec<Todo> = EntityQuery::new(TodoEntity::find())
    .filter(todo::Column::Done.eq(false))
    .order_by_asc(todo::Column::CreatedAt)
    .limit(10)
    .all(&db)
    .await?;

Implementations§

Source§

impl<T, E> EntityQuery<T, E>
where E: EntityTrait, T: From<E::Model> + Send + Sync, E::Model: FromQueryResult + Send + Sync,

Source

pub fn new(select: Select<E>) -> Self

Wrap an existing Select<E>.

Source

pub fn filter(self, f: impl IntoCondition) -> Self

Apply a WHERE condition.

Source

pub fn order_by_asc<C: ColumnTrait>(self, col: C) -> Self

ORDER BY col ASC.

Source

pub fn order_by_desc<C: ColumnTrait>(self, col: C) -> Self

ORDER BY col DESC.

Source

pub fn limit(self, n: u64) -> Self

LIMIT n rows.

Source

pub fn offset(self, n: u64) -> Self

OFFSET n rows.

Source

pub async fn all(self, db: &impl ConnectionTrait) -> Result<Vec<T>, Error>

Fetch all matching rows and convert each model to T.

Source

pub async fn one(self, db: &impl ConnectionTrait) -> Result<Option<T>, Error>

Fetch at most one row and convert to T if present.

Source

pub async fn count(self, db: &impl ConnectionTrait) -> Result<u64, Error>

Return the number of rows that match the current query.

Source

pub async fn paginate( self, db: &impl ConnectionTrait, params: &PageParams, ) -> Result<PageResult<T>, Error>

Offset-based pagination. Results are auto-converted to T.

Source

pub async fn paginate_cursor<C, V, F>( self, col: C, cursor_fn: F, db: &impl ConnectionTrait, params: &CursorParams<V>, ) -> Result<CursorResult<T>, Error>
where C: IntoIdentity, V: IntoValueTuple + Clone, F: Fn(&E::Model) -> String,

Cursor-based pagination. Results are auto-converted to T.

  • col — the column to paginate on (e.g. Column::Id).
  • cursor_fn — extracts the cursor string from a model instance.
Source

pub fn into_select(self) -> Select<E>

Unwrap the inner Select<E> for advanced SeaORM usage.

Auto Trait Implementations§

§

impl<T, E> Freeze for EntityQuery<T, E>

§

impl<T, E> RefUnwindSafe for EntityQuery<T, E>

§

impl<T, E> Send for EntityQuery<T, E>
where T: Send,

§

impl<T, E> Sync for EntityQuery<T, E>
where T: Sync,

§

impl<T, E> Unpin for EntityQuery<T, E>
where T: Unpin, E: Unpin,

§

impl<T, E> UnsafeUnpin for EntityQuery<T, E>

§

impl<T, E> UnwindSafe for EntityQuery<T, E>
where T: UnwindSafe, E: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> DefaultHooks for T

Source§

fn before_save(&mut self) -> Result<(), Error>

Called before the entity is inserted or updated.
Source§

fn after_save(&self) -> Result<(), Error>

Called after the entity has been successfully inserted or updated.
Source§

fn before_delete(&self) -> Result<(), Error>

Called before the entity is deleted.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,