Struct LoadExecutor 

pub struct LoadExecutor<E: EntityKind> { /* private fields */ }

LoadExecutor

Implementations

impl<E: EntityKind> LoadExecutor<E>

pub const fn new(db: Db<E::Canister>, debug: bool) -> Self

pub fn one_key(self, value: impl FieldValue) -> Result<Key, Error>

SHORTCUT METHODS

Fetch a primary key for a single matching row.

pub fn one_entity(self, value: impl FieldValue) -> Result<E, Error>

Fetch a single entity by field value.

pub fn one(&self, value: impl FieldValue) -> Result<Response<E>, Error>

BUILDER METHODS

Build and execute a query for a single matching row.

pub fn only(&self) -> Result<Response<E>, Error>

Build and execute a query for the unit primary key.

pub fn many( &self, values: impl IntoIterator<Item = impl FieldValue>, ) -> Result<Response<E>, Error>

Build and execute a query matching multiple primary keys.

pub fn all(&self) -> Result<Response<E>, Error>

Execute an unfiltered query for all rows.

pub fn filter<F, I>(self, f: F) -> Result<Response<E>, Error>

where F: FnOnce(FilterDsl) -> I, I: IntoFilterExpr,

Apply a filter builder and execute.

pub fn count_all(self) -> Result<u32, Error>

Count all rows (executes the query plan).

pub fn explain(self, query: LoadQuery) -> Result<QueryPlan, Error>

EXECUTION METHODS

Validate and return the query plan without executing.

pub fn execute(&self, query: LoadQuery) -> Result<Response<E>, Error>

Execute a full query and return a collection of entities.

pub fn count(self, query: LoadQuery) -> Result<u32, Error>

currently just doing the same as execute() keeping it separate in case we can optimise count queries in the future

Trait Implementations

impl<E: Clone + EntityKind> Clone for LoadExecutor<E>

where E::Canister: Clone,

fn clone(&self) -> LoadExecutor<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Copy + EntityKind> Copy for LoadExecutor<E>

where E::Canister: Copy,