Struct SystemConfig

pub struct SystemConfig {

    pub barrier_interval_ms: Option<u32>,
    pub checkpoint_frequency: Option<u64>,
    pub sstable_size_mb: Option<u32>,
    pub parallel_compact_size_mb: Option<u32>,
    pub block_size_kb: Option<u32>,
    pub bloom_false_positive: Option<f64>,
    pub state_store: Option<String>,
    pub data_directory: Option<String>,
    pub backup_storage_url: Option<String>,
    pub backup_storage_directory: Option<String>,
    pub max_concurrent_creating_streaming_jobs: Option<u32>,
    pub pause_on_next_bootstrap: Option<bool>,
    pub enable_tracing: Option<bool>,
    pub use_new_object_prefix_strategy: Option<bool>,
    pub license_key: Option<LicenseKey>,
    pub time_travel_retention_ms: Option<u64>,
}

The section [system] in risingwave.toml. All these fields are used to initialize the system parameters persisted in Meta store. Most fields are for testing purpose only and should not be documented.

Fields

barrier_interval_ms: Option<u32>

The interval of periodic barrier.

checkpoint_frequency: Option<u64>

There will be a checkpoint for every n barriers.

sstable_size_mb: Option<u32>

Target size of the Sstable.

parallel_compact_size_mb: Option<u32>

The size of parallel task for one compact/flush job.

block_size_kb: Option<u32>

Size of each block in bytes in SST.

bloom_false_positive: Option<f64>

False positive probability of bloom filter.

state_store: Option<String>

URL for the state store

data_directory: Option<String>

Remote directory for storing data and metadata objects.

backup_storage_url: Option<String>

Remote storage url for storing snapshots.

backup_storage_directory: Option<String>

Remote directory for storing snapshots.

max_concurrent_creating_streaming_jobs: Option<u32>

Max number of concurrent creating streaming jobs.

pause_on_next_bootstrap: Option<bool>

Whether to pause all data sources on next bootstrap.

enable_tracing: Option<bool>

Whether to enable distributed tracing.

use_new_object_prefix_strategy: Option<bool>

Whether to split object prefix.

license_key: Option<LicenseKey>

The license key to activate enterprise features.

time_travel_retention_ms: Option<u64>

The data retention period for time travel.

Implementations

impl SystemConfig

pub fn config_docs( name: String, docs: &mut BTreeMap<String, Vec<(String, String)>>, )

impl SystemConfig

pub fn into_init_system_params(self) -> SystemParams

Trait Implementations

impl Clone for SystemConfig

fn clone(&self) -> SystemConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SystemConfig

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

Formats the value using the given formatter.

impl Default for SystemConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SystemConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SystemConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.