Skip to main content

StorageSection

Struct StorageSection 

Source
pub struct StorageSection {
    pub backend: String,
    pub url: Option<String>,
    pub pool: Option<StoragePoolSection>,
}
Expand description

[storage] section. Selects the audit-log backend.

Default (absent or backend = "sqlite") uses the local rusqlite-backed store at [daemon].database. Production deployments should set backend = "postgres" and supply a connection URL — the local SQLite path is recommended only for testing and sandboxing because the audit log dies with the host (no off-box durability, nothing to forward to a SOC).

Example (Postgres, AWS RDS):

[storage]
backend = "postgres"
url     = "postgres://sysknife:${PG_PASSWORD}@db.example.com:5432/audit?sslmode=verify-full"

[storage.pool]
max_connections          = 8
acquire_timeout_secs     = 10
statement_cache_capacity = 100   # set to 0 for transaction-mode poolers

See docs/storage-cloud.md for cloud-provider URL reference.

Fields§

§backend: String

"sqlite" (default) or "postgres".

§url: Option<String>

Postgres connection URL (postgres://...). Required when backend = "postgres". Ignored otherwise.

§pool: Option<StoragePoolSection>

Optional pool tuning. Defaults are sane for typical SysKnife load.

Implementations§

Source§

impl StorageSection

Source

pub fn parsed(&self) -> Result<StorageBackend, String>

Project the relaxed deserialised form into the type-state-checked StorageBackend enum. Returns a human-readable error when the (backend, url, pool) tuple is inconsistent (unknown backend, postgres without url, etc.).

Trait Implementations§

Source§

impl Debug for StorageSection

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StorageSection

Source§

fn default() -> StorageSection

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for StorageSection

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.