DbSession

Struct DbSession 

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

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

Implementations§

Source§

impl<C: CanisterKind> DbSession<C>

Source

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

Create a new session scoped to the provided database.

Source

pub const fn debug(self) -> Self

Enable debug logging for subsequent queries in this session.

Source

pub const fn load<E>(&self) -> LoadExecutor<E>
where E: EntityKind<Canister = C>,

Get a LoadExecutor for building and executing queries that read entities.

Source

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.

Source

pub const fn delete<E>(&self) -> DeleteExecutor<E>
where E: EntityKind<Canister = C>,

Get a DeleteExecutor for deleting entities by key or query.

Source

pub fn insert<E>(&self, entity: E) -> Result<E, Error>
where E: EntityKind<Canister = C>,

Insert a new entity, returning the stored value.

Source

pub fn replace<E>(&self, entity: E) -> Result<E, Error>
where E: EntityKind<Canister = C>,

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

Source

pub fn update<E>(&self, entity: E) -> Result<E, Error>
where E: EntityKind<Canister = C>,

Partially update an existing entity.

Source

pub fn insert_view<E>(&self, view: E::ViewType) -> Result<E::ViewType, Error>
where E: EntityKind<Canister = C>,

Insert a new view value for an entity.

Source

pub fn replace_view<E>(&self, view: E::ViewType) -> Result<E::ViewType, Error>
where E: EntityKind<Canister = C>,

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

Source

pub fn update_view<E>(&self, view: E::ViewType) -> Result<E::ViewType, Error>
where E: EntityKind<Canister = C>,

Partially update an existing view.

Auto Trait Implementations§

§

impl<C> Freeze for DbSession<C>

§

impl<C> RefUnwindSafe for DbSession<C>
where C: RefUnwindSafe,

§

impl<C> Send for DbSession<C>
where C: Send,

§

impl<C> Sync for DbSession<C>
where C: Sync,

§

impl<C> Unpin for DbSession<C>
where C: Unpin,

§

impl<C> UnwindSafe for DbSession<C>
where C: 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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