Struct IcDbmsAgentClient 

pub struct IcDbmsAgentClient<'a> { /* private fields */ }

Available on crate feature ic-agent only.

Client to interact with an IC DBMS Canister using ic-agent.

Implementations

impl<'a> IcDbmsAgentClient<'a>

pub fn new(agent: &'a Agent, canister_id: Principal) -> Self

Initialize a new IcDbmsAgentClient with the given reference to an Agent, and the canister ID.

Trait Implementations

impl Client for IcDbmsAgentClient<'_>

fn principal(&self) -> Principal

Returns the Principal of the IC DBMS Canister.

async fn acl_add_principal( &self, principal: Principal, ) -> IcDbmsCanisterClientResult<IcDbmsResult<()>>

Adds the given principal to the ACL of the canister.

async fn acl_remove_principal( &self, principal: Principal, ) -> IcDbmsCanisterClientResult<IcDbmsResult<()>>

Removes the given principal from the ACL of the canister.

async fn acl_allowed_principals( &self, ) -> IcDbmsCanisterClientResult<Vec<Principal>>

Lists all principals in the ACL of the canister.

async fn begin_transaction(&self) -> IcDbmsCanisterClientResult<TransactionId>

Begins a new transaction and returns its ID.

async fn commit( &self, transaction_id: TransactionId, ) -> IcDbmsCanisterClientResult<IcDbmsResult<()>>

Commits the transaction with the given ID.

async fn rollback( &self, transaction_id: TransactionId, ) -> IcDbmsCanisterClientResult<IcDbmsResult<()>>

Rolls back the transaction with the given ID.

async fn select<T>( &self, table: &str, query: Query, transaction_id: Option<TransactionId>, ) -> IcDbmsCanisterClientResult<IcDbmsResult<Vec<T::Record>>>

where T: TableSchema, T::Record: CandidType + for<'de> Deserialize<'de>,

Executes a SELECT query on the IC DBMS Canister.

async fn select_raw( &self, table: &str, query: Query, transaction_id: Option<TransactionId>, ) -> IcDbmsCanisterClientResult<IcDbmsResult<Vec<Vec<(CandidColumnDef, Value)>>>>

Executes a SELECT query on the IC DBMS Canister and returns raw records (without deserialization).

async fn insert<T>( &self, table: &str, record: T::Insert, transaction_id: Option<TransactionId>, ) -> IcDbmsCanisterClientResult<IcDbmsResult<()>>

where T: TableSchema, T::Insert: InsertRecord<Schema = T> + CandidType,

Executes an INSERT query on the IC DBMS Canister.

async fn update<T>( &self, table: &str, patch: T::Update, transaction_id: Option<TransactionId>, ) -> IcDbmsCanisterClientResult<IcDbmsResult<u64>>

where T: TableSchema, T::Update: UpdateRecord<Schema = T> + CandidType,

Executes an UPDATE query on the IC DBMS Canister.

async fn delete<T>( &self, table: &str, behaviour: DeleteBehavior, filter: Option<Filter>, transaction_id: Option<TransactionId>, ) -> IcDbmsCanisterClientResult<IcDbmsResult<u64>>

where T: TableSchema,

Executes a DELETE query on the IC DBMS Canister.

impl<'a> Clone for IcDbmsAgentClient<'a>

fn clone(&self) -> IcDbmsAgentClient<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for IcDbmsAgentClient<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.