Struct bonsaidb::local::config::StorageConfiguration
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 */
}
Expand description
Configuration options for Storage
.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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
impl StorageConfiguration
pub fn register_schema<S>(&mut self) -> Result<(), Error>where
S: Schema,
pub fn register_schema<S>(&mut self) -> Result<(), Error>where S: Schema,
Registers the schema provided.
Trait Implementations§
§impl Builder for StorageConfiguration
impl Builder for StorageConfiguration
§fn with_schema<S>(self) -> Result<StorageConfiguration, Error>where
S: Schema,
fn with_schema<S>(self) -> Result<StorageConfiguration, Error>where S: Schema,
§fn memory_only(self) -> StorageConfiguration
fn memory_only(self) -> StorageConfiguration
StorageConfiguration::memory_only
to true and returns self.§fn path<P>(self, path: P) -> StorageConfigurationwhere
P: AsRef<Path>,
fn path<P>(self, path: P) -> StorageConfigurationwhere P: AsRef<Path>,
StorageConfiguration::path
to path
and returns self.§fn unique_id(self, unique_id: u64) -> StorageConfiguration
fn unique_id(self, unique_id: u64) -> StorageConfiguration
StorageConfiguration::unique_id
to unique_id
and returns self.§fn vault_key_storage<VaultKeyStorage>(
self,
key_storage: VaultKeyStorage
) -> StorageConfigurationwhere
VaultKeyStorage: AnyVaultKeyStorage,
fn vault_key_storage<VaultKeyStorage>( self, key_storage: VaultKeyStorage ) -> StorageConfigurationwhere VaultKeyStorage: AnyVaultKeyStorage,
StorageConfiguration::vault_key_storage
to key_storage
and returns self.§fn default_encryption_key(self, key: KeyId) -> StorageConfiguration
fn default_encryption_key(self, key: KeyId) -> StorageConfiguration
StorageConfiguration::default_encryption_key
to path
and returns self.§fn default_compression(self, compression: Compression) -> StorageConfiguration
fn default_compression(self, compression: Compression) -> StorageConfiguration
StorageConfiguration::default_compression
to path
and returns self.§fn tasks_worker_count(self, worker_count: usize) -> StorageConfiguration
fn tasks_worker_count(self, worker_count: usize) -> StorageConfiguration
Tasks::worker_count
to worker_count
and returns self.§fn tasks_parallelization(self, parallelization: usize) -> StorageConfiguration
fn tasks_parallelization(self, parallelization: usize) -> StorageConfiguration
Tasks::parallelization
to parallelization
and returns self.§fn check_view_integrity_on_open(self, check: bool) -> StorageConfiguration
fn check_view_integrity_on_open(self, check: bool) -> StorageConfiguration
Views::check_integrity_on_open
to check
and returns self.§fn key_value_persistence(
self,
persistence: KeyValuePersistence
) -> StorageConfiguration
fn key_value_persistence( self, persistence: KeyValuePersistence ) -> StorageConfiguration
StorageConfiguration::key_value_persistence
to persistence
and returns self.§fn authenticated_permissions<P>(
self,
authenticated_permissions: P
) -> StorageConfigurationwhere
P: Into<Permissions>,
fn authenticated_permissions<P>( self, authenticated_permissions: P ) -> StorageConfigurationwhere P: Into<Permissions>,
Self::authenticated_permissions
to authenticated_permissions
and returns self.§fn argon(self, argon: ArgonConfiguration) -> StorageConfiguration
fn argon(self, argon: ArgonConfiguration) -> StorageConfiguration
StorageConfiguration::argon
to argon
and returns self.§impl Clone for StorageConfiguration
impl Clone for StorageConfiguration
§fn clone(&self) -> StorageConfiguration
fn clone(&self) -> StorageConfiguration
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more