Struct SystemParamsReader

pub struct SystemParamsReader<I = PbSystemParams> {
    inner: I,
}

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

See SystemParamsRead for more details.

Fields

inner: I

Implementations

impl<I> SystemParamsReader<I>

where I: Borrow<PbSystemParams>,

pub fn new(inner: I) -> Self

pub fn as_ref(&self) -> SystemParamsReader<&PbSystemParams>

Return a new reader with the reference to the inner system params.

fn inner(&self) -> &PbSystemParams

Trait Implementations

impl<I: Clone> Clone for SystemParamsReader<I>

fn clone(&self) -> SystemParamsReader<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for SystemParamsReader<I>

where I: Borrow<PbSystemParams>,

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

Formats the value using the given formatter.

impl<I> From<I> for SystemParamsReader<I>

where I: Borrow<PbSystemParams>,

fn from(inner: I) -> Self

Converts to this type from the input type.

impl<I: PartialEq> PartialEq for SystemParamsReader<I>

fn eq(&self, other: &SystemParamsReader<I>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

fn barrier_interval_ms(&self) -> u32

The interval of periodic barrier.

fn checkpoint_frequency(&self) -> u64

There will be a checkpoint for every n barriers.

fn parallel_compact_size_mb(&self) -> u32

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

fn sstable_size_mb(&self) -> u32

Target size of the Sstable.

fn block_size_kb(&self) -> u32

Size of each block in bytes in SST.

fn bloom_false_positive(&self) -> f64

False positive probability of bloom filter.

fn state_store(&self) -> &str

URL for the state store

fn data_directory(&self) -> &str

Remote directory for storing data and metadata objects.

fn use_new_object_prefix_strategy(&self) -> bool

Whether to split object prefix.

fn backup_storage_url(&self) -> &str

Remote storage url for storing snapshots.

fn backup_storage_directory(&self) -> &str

Remote directory for storing snapshots.

fn max_concurrent_creating_streaming_jobs(&self) -> u32

Max number of concurrent creating streaming jobs.

fn pause_on_next_bootstrap(&self) -> bool

Whether to pause all data sources on next bootstrap.

fn enable_tracing(&self) -> bool

Whether to enable distributed tracing.

fn license_key(&self) -> LicenseKeyRef<'_>

The license key to activate enterprise features.

fn time_travel_retention_ms(&self) -> u64

The data retention period for time travel.

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

Return the information of all parameters.

impl<I> StructuralPartialEq for SystemParamsReader<I>