Module system_param

Expand description

This module defines utilities to work with system parameters ([PbSystemParams] in meta.proto).

To add a new system parameter:

Re-exports§

pub use crate::system_param::adaptive_parallelism_strategy::AdaptiveParallelismStrategy;

def_default 🔒: Define default value functions for those with Some default values.
def_default_opt 🔒: Define default value functions returning Option.
def_key 🔒: Define key constants for fields in PbSystemParams for use of other modules.
impl_check_missing_fields 🔒
impl_default_from_other_params 🔒: Define rules to derive a parameter from others. This is useful for parameter type change or semantic change, where a new parameter has to be introduced. When the cluster upgrades to a newer version, we need to ensure the effect of the new parameter is equal to its older versions. For example, if you had interval_sec and now you want finer granularity, you can introduce a new param interval_ms and try to derive it from interval_sec by overriding FromParams trait in OverrideFromParams:
impl_default_validation_on_set 🔒: Define check rules when a field is changed. If you want custom rules, please override the default implementation in OverrideValidateOnSet below.
impl_derive_missing_fields 🔒
impl_is_mutable 🔒
impl_param_value 🔒
impl_set_system_param 🔒
impl_system_params_for_test 🔒
impl_system_params_from_kv 🔒: Derive deserialization from kv pairs.
impl_system_params_to_kv 🔒: Derive serialization to kv pairs.

check_missing_params: Check if any undeprecated fields are missing.
derive_missing_fields
is_mutable
set_system_param: Set a system parameter with the given value or default one.
system_params_for_test
system_params_from_kv: Try to deserialize deprecated fields as well. Return error if there are unrecognized fields.
system_params_to_kv: The returned map only contains undeprecated fields. Return error if there are missing fields.