Struct coord::PersistConfig

pub struct PersistConfig {
    pub async_runtime: Option<Arc<TokioRuntime>>,
    pub storage: PersistStorage,
    pub user_table_enabled: bool,
    pub system_table_enabled: bool,
    pub kafka_sources_enabled: bool,
    pub lock_info: String,
    pub min_step_interval: Duration,
    pub cache_size_limit: Option<usize>,
}

Configuration of the persistence runtime and features.

Fields

async_runtime: Option<Arc<TokioRuntime>>

A runtime used for IO and cpu heavy work. The None case should only be used for PersistConfig::disabled (which is an awkward historical artifact).

TODO(benesch): can probably drop the Option now, but I didn’t see an immediately obvious refactor.

storage: PersistStorage

Where to store persisted data.

user_table_enabled: bool

Whether to persist all user tables. This is extremely experimental and should not even be tried by users. It’s initially here for end-to-end testing.

system_table_enabled: bool

Whether to persist certain system tables that have opted in. This is extremely experimental and should not even be tried by users. It’s initially here for end-to-end testing.

kafka_sources_enabled: bool

Whether to make Kafka sources persistent for fast restarts. This is extremely experimental and should not even be tried by users.

lock_info: String

Unstructured information stored in the “lock” files created by the log and blob to ensure that they are exclusive writers to those locations. This should contain whatever information might be useful to investigating an unexpected lock file (e.g. hostname and materialize version of the creating process).

min_step_interval: Duration

cache_size_limit: Option<usize>

Maximum size of the in-memory blob storage cache, in bytes.

Implementations

impl PersistConfig

pub fn disabled() -> Self

pub async fn init(
    &self,
    reentrance_id: Uuid,
    build: BuildInfo,
    reg: &MetricsRegistry
) -> Result<PersisterWithConfig, Error>

Initializes the persistence runtime and returns a clone-able handle for interacting with it. Returns None and does not start the runtime if all persistence features are disabled.

Trait Implementations

impl Clone for PersistConfig

fn clone(&self) -> PersistConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PersistConfig

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

Formats the value using the given formatter.