Struct SessionLoadQuery 

pub struct SessionLoadQuery<'a, C: CanisterKind, E: EntityKind<Canister = C>> { /* private fields */ }

SessionLoadQuery

Fluent, session-bound load query wrapper that keeps intent pure while routing execution through the DbSession boundary.

Implementations

impl<'a, C: CanisterKind, E: EntityKind<Canister = C>> SessionLoadQuery<'a, C, E>

pub const fn query(&self) -> &Query<E>

Return a reference to the underlying query intent.

pub fn key(self, key: impl Into<Key>) -> Self

Filter by primary key.

pub fn many<I>(self, keys: I) -> Self

where I: IntoIterator<Item = E::PrimaryKey>,

Load multiple entities by primary key.

Semantics:

• Equivalent to WHERE pk IN (…)
• Uses key-based access (ByKey / ByKeys)
• Missing keys are ignored in MissingOk mode
• Strict mode treats missing rows as corruption

pub fn filter(self, predicate: Predicate) -> Self

Add a predicate, implicitly AND-ing with any existing predicate.

pub fn order_by(self, field: impl AsRef<str>) -> Self

Append an ascending sort key.

pub fn order_by_desc(self, field: impl AsRef<str>) -> Self

Append a descending sort key.

pub fn limit(self, limit: u32) -> Self

Apply a load limit to bound result size.

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

Apply a load offset.

pub fn explain(&self) -> Result<ExplainPlan, QueryError>

Explain this query without executing it.

pub fn plan(&self) -> Result<ExecutablePlan<E>, QueryError>

Plan this query into an executor-ready plan.

pub fn execute(&self) -> Result<Response<E>, QueryError>

Execute this query using the session’s policy settings.

pub fn exists(&self) -> Result<bool, QueryError>

Return whether any rows match this query.

pub fn count(&self) -> Result<u64, QueryError>

Execute and return the number of matching rows.

pub fn all(&self) -> Result<Vec<E>, QueryError>

Execute and return all entities.

pub fn views(&self) -> Result<Vec<View<E>>, QueryError>

Execute and return all results as views.

pub fn one(&self) -> Result<E, QueryError>

Execute and require exactly one entity.

pub fn view(&self) -> Result<View<E>, QueryError>

Execute and require exactly one view.

pub fn one_opt(&self) -> Result<Option<E>, QueryError>

Execute and return zero or one entity.

pub fn view_opt(&self) -> Result<Option<View<E>>, QueryError>

Execute and return zero or one view.

impl<C: CanisterKind, E: EntityKind<Canister = C, PrimaryKey = ()>> SessionLoadQuery<'_, C, E>

pub fn only(self) -> Self

Load the singleton entity identified by the unit primary key ().

Semantics:

• Equivalent to WHERE pk = ()
• Uses key-based access (ByKey)
• Does not allow predicates
• MissingOk mode returns empty
• Strict mode treats missing row as corruption