Struct RocksDbDatabaseInternal

pub struct RocksDbDatabaseInternal { /* private fields */ }

Database-level connection to RocksDB for managing namespaces and partitions.

Trait Implementations

impl Clone for RocksDbDatabaseInternal

fn clone(&self) -> RocksDbDatabaseInternal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl KeyValueDatabase for RocksDbDatabaseInternal

type Config = RocksDbStoreInternalConfig

The configuration needed to interact with a new backend.

type Store = RocksDbStoreInternal

The result of opening a partition.

fn get_name() -> String

The name of this database.

async fn connect( config: &Self::Config, namespace: &str, ) -> Result<Self, RocksDbStoreInternalError>

Connects to an existing namespace using the given configuration.

fn open_shared( &self, root_key: &[u8], ) -> Result<Self::Store, RocksDbStoreInternalError>

Opens a shared partition starting at root_key. It is understood that the partition MAY be read and written simultaneously from other clients.

fn open_exclusive( &self, root_key: &[u8], ) -> Result<Self::Store, RocksDbStoreInternalError>

Opens an exclusive partition starting at root_key. It is assumed that the partition WILL NOT be read and written simultaneously by other clients.

async fn list_all( config: &Self::Config, ) -> Result<Vec<String>, RocksDbStoreInternalError>

Obtains the list of existing namespaces.

async fn list_root_keys( config: &Self::Config, namespace: &str, ) -> Result<Vec<Vec<u8>>, RocksDbStoreInternalError>

Lists the root keys of the namespace. It is possible that some root keys have no keys.

async fn delete_all( config: &Self::Config, ) -> Result<(), RocksDbStoreInternalError>

Deletes all the existing namespaces.

async fn exists( config: &Self::Config, namespace: &str, ) -> Result<bool, RocksDbStoreInternalError>

Tests if a given namespace exists.

async fn create( config: &Self::Config, namespace: &str, ) -> Result<(), RocksDbStoreInternalError>

Creates a namespace. Returns an error if the namespace exists.

async fn delete( config: &Self::Config, namespace: &str, ) -> Result<(), RocksDbStoreInternalError>

Deletes the given namespace.

fn maybe_create_and_connect( config: &Self::Config, namespace: &str, ) -> impl Future<Output = Result<Self, Self::Error>> + Send + Sync

Initializes a storage if missing and provides it.

fn recreate_and_connect( config: &Self::Config, namespace: &str, ) -> impl Future<Output = Result<Self, Self::Error>> + Send + Sync

Creates a new storage. Overwrites it if this namespace already exists.

impl TestKeyValueDatabase for RocksDbDatabaseInternal

async fn new_test_config() -> Result<RocksDbStoreInternalConfig, RocksDbStoreInternalError>

Obtains a test config

async fn connect_test_namespace() -> Result<Self, Self::Error>

Creates a database for testing purposes

async fn new_test_store() -> Result<Self::Store, Self::Error>

Creates a store for testing purposes

impl WithError for RocksDbDatabaseInternal

type Error = RocksDbStoreInternalError

The error type.