risingwave_common::system_param::reader

Trait SystemParamsRead

source 
pub trait SystemParamsRead {

Show 17 methods    // Required methods
    fn barrier_interval_ms(&self) -> <u32 as ParamValue>::Borrowed<'_>;
    fn checkpoint_frequency(&self) -> <u64 as ParamValue>::Borrowed<'_>;
    fn sstable_size_mb(&self) -> <u32 as ParamValue>::Borrowed<'_>;
    fn parallel_compact_size_mb(&self) -> <u32 as ParamValue>::Borrowed<'_>;
    fn block_size_kb(&self) -> <u32 as ParamValue>::Borrowed<'_>;
    fn bloom_false_positive(&self) -> <f64 as ParamValue>::Borrowed<'_>;
    fn state_store(&self) -> <String as ParamValue>::Borrowed<'_>;
    fn data_directory(&self) -> <String as ParamValue>::Borrowed<'_>;
    fn backup_storage_url(&self) -> <String as ParamValue>::Borrowed<'_>;
    fn backup_storage_directory(&self) -> <String as ParamValue>::Borrowed<'_>;
    fn max_concurrent_creating_streaming_jobs(
        &self,
    ) -> <u32 as ParamValue>::Borrowed<'_>;
    fn pause_on_next_bootstrap(&self) -> <bool as ParamValue>::Borrowed<'_>;
    fn enable_tracing(&self) -> <bool as ParamValue>::Borrowed<'_>;
    fn use_new_object_prefix_strategy(
        &self,
    ) -> <bool as ParamValue>::Borrowed<'_>;
    fn license_key(&self) -> <LicenseKey as ParamValue>::Borrowed<'_>;
    fn time_travel_retention_ms(&self) -> <u64 as ParamValue>::Borrowed<'_>;

    // Provided method
    fn get_all(&self) -> Vec<ParameterInfo> { ... }

}
Expand description

The trait delegating reads on risingwave_pb::meta::SystemParams.

Purposes:

  • Avoid misuse of deprecated fields by hiding their getters.
  • Abstract fallback logic for fields that might not be provided by meta service due to backward compatibility.
  • Redact sensitive fields by returning a newtype around the original value.

Required Methods§

source

fn barrier_interval_ms(&self) -> <u32 as ParamValue>::Borrowed<'_>

The interval of periodic barrier.

source

fn checkpoint_frequency(&self) -> <u64 as ParamValue>::Borrowed<'_>

There will be a checkpoint for every n barriers.

source

fn sstable_size_mb(&self) -> <u32 as ParamValue>::Borrowed<'_>

Target size of the Sstable.

source

fn parallel_compact_size_mb(&self) -> <u32 as ParamValue>::Borrowed<'_>

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

source

fn block_size_kb(&self) -> <u32 as ParamValue>::Borrowed<'_>

Size of each block in bytes in SST.

source

fn bloom_false_positive(&self) -> <f64 as ParamValue>::Borrowed<'_>

False positive probability of bloom filter.

source

fn state_store(&self) -> <String as ParamValue>::Borrowed<'_>

URL for the state store

source

fn data_directory(&self) -> <String as ParamValue>::Borrowed<'_>

Remote directory for storing data and metadata objects.

source

fn backup_storage_url(&self) -> <String as ParamValue>::Borrowed<'_>

Remote storage url for storing snapshots.

source

fn backup_storage_directory(&self) -> <String as ParamValue>::Borrowed<'_>

Remote directory for storing snapshots.

source

fn max_concurrent_creating_streaming_jobs( &self, ) -> <u32 as ParamValue>::Borrowed<'_>

Max number of concurrent creating streaming jobs.

source

fn pause_on_next_bootstrap(&self) -> <bool as ParamValue>::Borrowed<'_>

Whether to pause all data sources on next bootstrap.

source

fn enable_tracing(&self) -> <bool as ParamValue>::Borrowed<'_>

Whether to enable distributed tracing.

source

fn use_new_object_prefix_strategy(&self) -> <bool as ParamValue>::Borrowed<'_>

Whether to split object prefix.

source

fn license_key(&self) -> <LicenseKey as ParamValue>::Borrowed<'_>

The license key to activate enterprise features.

source

fn time_travel_retention_ms(&self) -> <u64 as ParamValue>::Borrowed<'_>

The data retention period for time travel.

Provided Methods§

source

fn get_all(&self) -> Vec<ParameterInfo>

Return the information of all parameters.

Implementors§

source§

impl<I> SystemParamsRead for SystemParamsReader<I>
where I: Borrow<PbSystemParams>,

  • Unwrap the field if it always exists. For example, if a parameter is introduced before the initial public release.

  • Otherwise, specify the fallback logic when the field is missing.