Struct Admin 

pub struct Admin { /* private fields */ }

Catalog (admin) client for a transactor endpoint.

Implementations

impl Admin

pub async fn connect( endpoint: &str, token: Option<String>, tls: Option<ClientTlsConfig>, ) -> Result<Self, PeerError>

Connects to a transactor’s catalog service.

Errors

Returns PeerError when the endpoint is unreachable.

pub async fn create_database( &mut self, db: &str, schema: &[Edn], ) -> Result<bool, PeerError>

Creates a database with EDN schema forms; false when it existed.

Errors

Returns PeerError for invalid schema or transport failure.

pub async fn create_database_with_key( &mut self, db: &str, schema: &[Edn], storage_key: Option<&str>, ) -> Result<bool, PeerError>

Creates a database, optionally encrypted at rest under storage_key.

storage_key is a key-encryption key URI the transactor resolves — it is where the database’s data keys are wrapped, and no key material crosses this connection. It is fixed at creation: a database made without one can only become encrypted through a backup and restore.

Errors

Returns PeerError for invalid schema, a key the transactor cannot resolve, or transport failure.

pub async fn key_status( &mut self, db: &str, ) -> Result<KeyStatusResponse, PeerError>

Reports a database’s storage-encryption keys and their epochs.

Errors

Returns PeerError on transport failure or an unknown database.

pub async fn rotate_storage_key(&mut self, db: &str) -> Result<u32, PeerError>

Opens a new storage-key epoch that new writes use, rewriting nothing.

Errors

Returns PeerError on transport failure, an unknown or unencrypted database, or a key the transactor cannot wrap under.

pub async fn rewrap_keys( &mut self, db: &str, kek: &str, ) -> Result<(), PeerError>

Re-wraps every data key under kek. No stored data is touched.

Errors

Returns PeerError on transport failure, an unknown or unencrypted database, or a KEK the transactor cannot resolve.

pub async fn fork_database( &mut self, db: &str, target: &str, as_of_t: Option<u64>, ) -> Result<Option<u64>, PeerError>

Forks db into a new database target duplicating it at transaction basis as_of_t (None forks at the current basis). Returns the fork’s basis, or None when the target already existed.

Errors

Returns PeerError on transport failure, an unknown source, an invalid target name, or a basis ahead of the source’s.

pub async fn delete_database(&mut self, db: &str) -> Result<bool, PeerError>

Deletes a database; false when it did not exist.

Errors

Returns PeerError on transport failure.

pub async fn list_databases(&mut self) -> Result<Vec<String>, PeerError>

Lists hosted databases.

Errors

Returns PeerError on transport failure.

pub async fn gc_deleted_databases(&mut self) -> Result<u64, PeerError>

Sweeps blobs unreachable from every live database root.

Errors

Returns PeerError on transport failure.

pub async fn gc_deleted_databases_with_retention( &mut self, retention: Option<Duration>, ) -> Result<u64, PeerError>

Sweeps unreachable blobs with an optional minimum retention window.

Errors

Returns PeerError on transport failure.

pub async fn request_index(&mut self, db: &str) -> Result<u64, PeerError>

Asks the transactor to publish db’s covering indexes now, bypassing its pacing policy; returns the resulting index basis.

Errors

Returns PeerError on transport failure or an unknown database.

pub async fn set_index_policy( &mut self, db: &str, update: IndexPolicySettings, ) -> Result<IndexPolicySettings, PeerError>

Overrides db’s index-publication pacing at runtime; None fields are left unchanged, so an all-None update reads the current policy. Returns the policy now in effect.

Errors

Returns PeerError on transport failure or an unknown database.

pub async fn get_storage_info( &mut self, db: &str, ) -> Result<GetStorageInfoResponse, PeerError>

Fixes the current transaction basis and returns an independent connection to the transactor’s underlying storage service, for a backup client or a storage-aware peer bootstrapping from storage.

Errors

Returns PeerError for an unknown database or transport failure.