Struct DbSession 

pub struct DbSession<C: CanisterKind> { /* private fields */ }

DbSession Database handle plus a debug flag that controls executor verbosity.

Implementations

impl<C: CanisterKind> DbSession<C>

pub const fn new(db: Db<C>) -> Self

Create a new session scoped to the provided database.

pub const fn debug(self) -> Self

Enable debug logging for subsequent queries in this session.

pub const fn metrics_sink(self, sink: &'static dyn MetricsSink) -> Self

Override the metrics sink for operations executed through this session.

pub const fn load<E>(&self) -> LoadExecutor<E>

where E: EntityKind<Canister = C>,

Get a LoadExecutor for building and executing queries that read entities. Note: executor methods do not apply the session metrics override.

pub const fn save<E>(&self) -> SaveExecutor<E>

where E: EntityKind<Canister = C>,

Get a SaveExecutor for inserting or updating entities.

Normally you will use the higher-level create/replace/update shortcuts instead. Note: executor methods do not apply the session metrics override.

pub const fn upsert<E>(&self) -> UpsertExecutor<E>

where E: EntityKind<Canister = C>, E::PrimaryKey: FromKey,

Get an UpsertExecutor for inserting or updating by a unique index. Note: executor methods do not apply the session metrics override.

pub const fn delete<E>(&self) -> DeleteExecutor<E>

where E: EntityKind<Canister = C>,

Get a DeleteExecutor for deleting entities by key or query. Note: executor methods do not apply the session metrics override.

pub fn insert<E>(&self, entity: E) -> Result<E, InternalError>

where E: EntityKind<Canister = C>,

Insert a new entity, returning the stored value.

pub fn insert_many<E>( &self, entities: impl IntoIterator<Item = E>, ) -> Result<Vec<E>, InternalError>

where E: EntityKind<Canister = C>,

Insert multiple entities, returning stored values.

pub fn replace<E>(&self, entity: E) -> Result<E, InternalError>

where E: EntityKind<Canister = C>,

Replace an existing entity or insert it if it does not yet exist.

pub fn replace_many<E>( &self, entities: impl IntoIterator<Item = E>, ) -> Result<Vec<E>, InternalError>

where E: EntityKind<Canister = C>,

Replace multiple entities, inserting if missing.

pub fn update<E>(&self, entity: E) -> Result<E, InternalError>

where E: EntityKind<Canister = C>,

Partially update an existing entity.

pub fn update_many<E>( &self, entities: impl IntoIterator<Item = E>, ) -> Result<Vec<E>, InternalError>

where E: EntityKind<Canister = C>,

Partially update multiple existing entities.

pub fn insert_view<E>( &self, view: E::ViewType, ) -> Result<E::ViewType, InternalError>

where E: EntityKind<Canister = C>,

Insert a new view value for an entity.

pub fn replace_view<E>( &self, view: E::ViewType, ) -> Result<E::ViewType, InternalError>

where E: EntityKind<Canister = C>,

Replace an existing view or insert it if it does not yet exist.

pub fn update_view<E>( &self, view: E::ViewType, ) -> Result<E::ViewType, InternalError>

where E: EntityKind<Canister = C>,

Partially update an existing view.