Module system_param

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

To add a new system parameter:

• Add a new field to PbSystemParams in meta.proto.
• Add a new entry to for_all_undeprecated_params in this file.
• Add a new method to reader::SystemParamsReader.

Modules

• common
• default
  Default values for all parameters.
• diff
• local_manager
• reader

Macros

• 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.

Structs

• OverrideFromParams 🔒
• OverrideValidateOnSet 🔒

Constants

• BACKUP_STORAGE_DIRECTORY_KEY
• BACKUP_STORAGE_URL_KEY
• BARRIER_INTERVAL_MS_KEY
• BLOCK_SIZE_KB_KEY
• BLOOM_FALSE_POSITIVE_KEY
• CHECKPOINT_FREQUENCY_KEY
• DATA_DIRECTORY_KEY
• ENABLE_TRACING_KEY
• LICENSE_KEY_KEY
• MAX_CONCURRENT_CREATING_STREAMING_JOBS_KEY
• PARALLEL_COMPACT_SIZE_MB_KEY
• PAUSE_ON_NEXT_BOOTSTRAP_KEY
• SSTABLE_SIZE_MB_KEY
• STATE_STORE_KEY
• TIME_TRAVEL_RETENTION_MS_KEY
• USE_NEW_OBJECT_PREFIX_STRATEGY_KEY

Traits

• FromParams 🔒
• ParamValue
  The trait for the value type of a system parameter.
• ValidateOnSet 🔒

Functions

• 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.

Type Aliases

• Result 🔒
• SystemParamsError