Struct tari_storage::lmdb_store::LMDBBuilder

pub struct LMDBBuilder { /* fields omitted */ }

A builder for LMDBStore

Example

Create a new LMDB database of 500MB in the db directory with two named databases: "db1" and "db2"

let mut store = LMDBBuilder::new()
    .set_path(env::temp_dir())
    .set_environment_size(500)
    .set_max_number_of_databases(10)
    .add_database("db1", db::CREATE)
    .add_database("db2", db::CREATE)
    .build()
    .unwrap();

Implementations

impl LMDBBuilder

pub fn new() -> LMDBBuilder

Create a new LMDBStore builder. Set up the database by calling set_nnnn and then create the database with build(). The default values for the database parameters are:

Parameter	Default
path	./store/
size	64 MB
named DBs	none

pub fn set_path<P: AsRef<Path>>(self, path: P) -> LMDBBuilder

Set the directory where the LMDB database exists, or must be created. Note: The directory must exist already; it is not created for you. If it does not exist, build() will return LMDBError::InvalidPath.

pub fn set_environment_size(self, size: usize) -> LMDBBuilder

Sets the size of the environment, in MB. The actual memory will only be allocated when #build() is called

pub fn set_max_number_of_databases(self, size: usize) -> LMDBBuilder

Sets the maximum number of databases (tables) in the environment. If this value is less than the number of DBs that will be created when the environment is built, this value will be ignored.

pub fn add_database(self, name: &str, flags: Flags) -> LMDBBuilder

Add an additional named database to the LMDB environment.If add_database isn't called at least once, only the default database is created.

pub fn build(self) -> Result<LMDBStore, LMDBError>

Create a new LMDBStore instance and open the underlying database environment

Trait Implementations

impl Default for LMDBBuilder

fn default() -> LMDBBuilder

Returns the "default value" for a type.