EsQuery

Struct EsQuery 

Source
pub struct EsQuery<'q, Repo, Flavor, F, A> { /* private fields */ }
Expand description

Query builder for event-sourced entities.

This type is generated by the es_query! macro and should not be constructed directly. It wraps a SQLx query and provides methods to fetch and hydrate entities from their events.

Implementations§

Source§

impl<'q, Repo, Flavor, F, A> EsQuery<'q, Repo, Flavor, F, A>
where Repo: EsRepo, <<<Repo as EsRepo>::Entity as EsEntity>::Event as EsEvent>::EntityId: Unpin, F: FnMut(PgRow) -> Result<GenericEvent<<<<Repo as EsRepo>::Entity as EsEntity>::Event as EsEvent>::EntityId>, Error> + Send, A: 'q + Send + IntoArguments<'q, Postgres>,

Source

pub fn new(query: Map<'q, Postgres, F, A>) -> Self

Source§

impl<'q, Repo, F, A> EsQuery<'q, Repo, EsQueryFlavorFlat, F, A>
where Repo: EsRepo, <<<Repo as EsRepo>::Entity as EsEntity>::Event as EsEvent>::EntityId: Unpin, F: FnMut(PgRow) -> Result<GenericEvent<<<<Repo as EsRepo>::Entity as EsEntity>::Event as EsEvent>::EntityId>, Error> + Send, A: 'q + Send + IntoArguments<'q, Postgres>,

Source

pub async fn fetch_optional( self, op: impl IntoOneTimeExecutor<'_>, ) -> Result<Option<<Repo as EsRepo>::Entity>, <Repo as EsRepo>::Err>

Fetches at most one entity from the query results.

Returns Ok(None) if no entities match the query, or Ok(Some(entity)) if found.

Source

pub async fn fetch_one( self, op: impl IntoOneTimeExecutor<'_>, ) -> Result<<Repo as EsRepo>::Entity, <Repo as EsRepo>::Err>

Fetches exactly one entity from the query results.

Returns an error if no entities match or if the entity cannot be loaded.

Source

pub async fn fetch_n( self, op: impl IntoOneTimeExecutor<'_>, first: usize, ) -> Result<(Vec<<Repo as EsRepo>::Entity>, bool), <Repo as EsRepo>::Err>

Fetches up to first entities from the query results.

Returns a tuple of (entities, has_more) where has_more indicates if there were more entities available beyond the requested limit.

Source§

impl<'q, Repo, F, A> EsQuery<'q, Repo, EsQueryFlavorNested, F, A>
where Repo: EsRepo, <<<Repo as EsRepo>::Entity as EsEntity>::Event as EsEvent>::EntityId: Unpin, F: FnMut(PgRow) -> Result<GenericEvent<<<<Repo as EsRepo>::Entity as EsEntity>::Event as EsEvent>::EntityId>, Error> + Send, A: 'q + Send + IntoArguments<'q, Postgres>,

Source

pub async fn fetch_optional<OP>( self, op: &mut OP, ) -> Result<Option<<Repo as EsRepo>::Entity>, <Repo as EsRepo>::Err>
where OP: AtomicOperation,

Fetches at most one entity and loads all nested relationships.

Returns Ok(None) if no entities match, or Ok(Some(entity)) with all nested entities loaded if found.

Source

pub async fn fetch_one<OP>( self, op: &mut OP, ) -> Result<<Repo as EsRepo>::Entity, <Repo as EsRepo>::Err>
where OP: AtomicOperation,

Fetches exactly one entity and loads all nested relationships.

Returns an error if no entities match or if the entity/nested relationships cannot be loaded.

Source

pub async fn fetch_n<OP>( self, op: &mut OP, first: usize, ) -> Result<(Vec<<Repo as EsRepo>::Entity>, bool), <Repo as EsRepo>::Err>
where OP: AtomicOperation,

Fetches up to first entities and loads all nested relationships.

Returns a tuple of (entities, has_more) where all entities have their nested relationships loaded, and has_more indicates if more entities were available.

Auto Trait Implementations§

§

impl<'q, Repo, Flavor, F, A> Freeze for EsQuery<'q, Repo, Flavor, F, A>
where F: Freeze, A: Freeze,

§

impl<'q, Repo, Flavor, F, A> !RefUnwindSafe for EsQuery<'q, Repo, Flavor, F, A>

§

impl<'q, Repo, Flavor, F, A> Send for EsQuery<'q, Repo, Flavor, F, A>
where F: Send, Repo: Send, Flavor: Send, A: Send,

§

impl<'q, Repo, Flavor, F, A> Sync for EsQuery<'q, Repo, Flavor, F, A>
where F: Sync, Repo: Sync, Flavor: Sync, A: Sync,

§

impl<'q, Repo, Flavor, F, A> Unpin for EsQuery<'q, Repo, Flavor, F, A>
where F: Unpin, Repo: Unpin, Flavor: Unpin, A: Unpin,

§

impl<'q, Repo, Flavor, F, A> !UnwindSafe for EsQuery<'q, Repo, Flavor, F, A>

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

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
§

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

§

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
§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

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