Struct bonsaidb_local::config::StorageConfiguration

#[non_exhaustive]
pub struct StorageConfiguration {
    pub path: Option<PathBuf>,
    pub memory_only: bool,
    pub unique_id: Option<u64>,
    pub vault_key_storage: Option<Arc<dyn AnyVaultKeyStorage>>,
    pub default_encryption_key: Option<KeyId>,
    pub workers: Tasks,
    pub views: Views,
    pub key_value_persistence: KeyValuePersistence,
    pub default_compression: Option<Compression>,
    pub authenticated_permissions: Permissions,
    pub argon: ArgonConfiguration,
    /* private fields */
}

Configuration options for Storage.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: Option<PathBuf>

The path to the database. Defaults to db.bonsaidb if not specified.

memory_only: bool

Prevents storing data on the disk. This is intended for testing purposes primarily. Keep in mind that the underlying storage format is append-only.

unique_id: Option<u64>

The unique id of the server. If not specified, the server will randomly generate a unique id on startup. If the server generated an id and this value is subsequently set, the generated id will be overridden by the one specified here.

vault_key_storage: Option<Arc<dyn AnyVaultKeyStorage>>

The vault key storage to use. If not specified, LocalVaultKeyStorage will be used with the server’s data folder as the path. This is incredibly insecure and should not be used outside of testing.

For secure encryption, it is important to store the vault keys in a location that is separate from the database. If the keys are on the same hardware as the encrypted content, anyone with access to the disk will be able to decrypt the stored data.

default_encryption_key: Option<KeyId>

The default encryption key for the database. If specified, all documents will be stored encrypted at-rest using the key specified. Having this key specified will also encrypt views. Without this, views will be stored unencrypted.

workers: Tasks

Configuration options related to background tasks.

views: Views

Configuration options related to views.

key_value_persistence: KeyValuePersistence

Controls how the key-value store persists keys, on a per-database basis.

default_compression: Option<Compression>

Sets the default compression algorithm.

authenticated_permissions: Permissions

The permissions granted to authenticated connections to this server.

argon: ArgonConfiguration

Password hashing configuration.

Implementations

impl StorageConfiguration

pub fn register_schema<S: Schema>(&mut self) -> Result<(), Error>

Registers the schema provided.

Trait Implementations

impl Builder for StorageConfiguration

fn with_schema<S: Schema>(self) -> Result<Self, Error>

Registers the schema and returns self.

fn memory_only(self) -> Self

Sets StorageConfiguration::path to true and returns self.

fn path<P: AsRef<Path>>(self, path: P) -> Self

Sets StorageConfiguration::path to path and returns self.

fn unique_id(self, unique_id: u64) -> Self

Sets StorageConfiguration::unique_id to unique_id and returns self.

fn vault_key_storage<VaultKeyStorage: AnyVaultKeyStorage>(
    self,
    key_storage: VaultKeyStorage
) -> Self

Sets StorageConfiguration::vault_key_storage to key_storage and returns self.

fn default_encryption_key(self, key: KeyId) -> Self

Sets StorageConfiguration::default_encryption_key to path and returns self.

fn default_compression(self, compression: Compression) -> Self

Sets StorageConfiguration::default_compression to path and returns self.

fn tasks_worker_count(self, worker_count: usize) -> Self

Sets Tasks::worker_count to worker_count and returns self.

fn tasks_parallelization(self, parallelization: usize) -> Self

Sets Tasks::parallelization to parallelization and returns self.

fn check_view_integrity_on_open(self, check: bool) -> Self

Sets Views::check_integrity_on_open to check and returns self.

fn key_value_persistence(self, persistence: KeyValuePersistence) -> Self

Sets StorageConfiguration::key_value_persistence to persistence and returns self.

fn authenticated_permissions<P: Into<Permissions>>(
    self,
    authenticated_permissions: P
) -> Self

Sets Self::authenticated_permissions to authenticated_permissions and returns self.

fn argon(self, argon: ArgonConfiguration) -> Self

Sets StorageConfiguration::argon to argon and returns self.

fn new<P: AsRef<Path>>(path: P) -> Self

Creates a default configuration with path set.

impl Clone for StorageConfiguration

fn clone(&self) -> StorageConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageConfiguration

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

Formats the value using the given formatter.

impl Default for StorageConfiguration

fn default() -> Self

Returns the “default value” for a type.