Struct MetaConfig

pub struct MetaConfig {

    pub min_sst_retention_time_sec: u64,
    pub full_gc_interval_sec: u64,
    pub full_gc_object_limit: u64,
    pub gc_history_retention_time_sec: u64,
    pub max_inflight_time_travel_query: u64,
    pub periodic_compaction_interval_sec: u64,
    pub vacuum_interval_sec: u64,
    pub vacuum_spin_interval_ms: u64,
    pub hummock_version_checkpoint_interval_sec: u64,
    pub enable_hummock_data_archive: bool,
    pub hummock_time_travel_snapshot_interval: u64,
    pub min_delta_log_num_for_hummock_version_checkpoint: u64,
    pub max_heartbeat_interval_secs: u32,
    pub disable_recovery: bool,
    pub disable_automatic_parallelism_control: bool,
    pub parallelism_control_batch_size: usize,
    pub parallelism_control_trigger_period_sec: u64,
    pub parallelism_control_trigger_first_delay_sec: u64,
    pub meta_leader_lease_secs: u64,
    pub dangerous_max_idle_secs: Option<u64>,
    pub default_parallelism: DefaultParallelism,
    pub enable_compaction_deterministic: bool,
    pub enable_committed_sst_sanity_check: bool,
    pub node_num_monitor_interval_sec: u64,
    pub backend: MetaBackend,
    pub periodic_space_reclaim_compaction_interval_sec: u64,
    pub periodic_ttl_reclaim_compaction_interval_sec: u64,
    pub periodic_tombstone_reclaim_compaction_interval_sec: u64,
    pub move_table_size_limit: u64,
    pub split_group_size_limit: u64,
    pub cut_table_size_limit: u64,
    pub unrecognized: Unrecognized<Self>,
    pub do_not_config_object_storage_lifecycle: bool,
    pub partition_vnode_count: u32,
    pub table_high_write_throughput_threshold: u64,
    pub table_low_write_throughput_threshold: u64,
    pub compaction_task_max_heartbeat_interval_secs: u64,
    pub compaction_task_max_progress_interval_secs: u64,
    pub compaction_config: CompactionConfig,
    pub hybrid_partition_vnode_count: u32,
    pub event_log_enabled: bool,
    pub event_log_channel_max_size: u32,
    pub developer: MetaDeveloperConfig,
    pub enable_dropped_column_reclaim: bool,
    pub split_group_size_ratio: f64,
    pub table_stat_high_write_throughput_ratio_for_split: f64,
    pub table_stat_low_write_throughput_ratio_for_merge: f64,
    pub table_stat_throuput_window_seconds_for_split: usize,
    pub table_stat_throuput_window_seconds_for_merge: usize,
    pub compact_task_table_size_partition_threshold_low: u64,
    pub compact_task_table_size_partition_threshold_high: u64,
    pub periodic_scheduling_compaction_group_split_interval_sec: u64,
    pub periodic_scheduling_compaction_group_merge_interval_sec: u64,
    pub meta_store_config: MetaStoreConfig,
}

The section [meta] in risingwave.toml.

Fields

min_sst_retention_time_sec: u64

Objects within min_sst_retention_time_sec won’t be deleted by hummock full GC, even they are dangling.

full_gc_interval_sec: u64

Interval of automatic hummock full GC.

full_gc_object_limit: u64

Max number of object per full GC job can fetch.

gc_history_retention_time_sec: u64

Duration in seconds to retain garbage collection history data.

max_inflight_time_travel_query: u64

Max number of inflight time travel query.

periodic_compaction_interval_sec: u64

Schedule compaction for all compaction groups with this interval.

vacuum_interval_sec: u64

Interval of invoking a vacuum job, to remove stale metadata from meta store and objects from object store.

vacuum_spin_interval_ms: u64

The spin interval inside a vacuum job. It avoids the vacuum job monopolizing resources of meta node.

hummock_version_checkpoint_interval_sec: u64

Interval of hummock version checkpoint.

enable_hummock_data_archive: bool

If enabled, SSTable object file and version delta will be retained.

SSTable object file need to be deleted via full GC.

version delta need to be manually deleted.

hummock_time_travel_snapshot_interval: u64

The interval at which a Hummock version snapshot is taken for time travel.

Larger value indicates less storage overhead but worse query performance.

min_delta_log_num_for_hummock_version_checkpoint: u64

The minimum delta log number a new checkpoint should compact, otherwise the checkpoint attempt is rejected.

max_heartbeat_interval_secs: u32

Maximum allowed heartbeat interval in seconds.

disable_recovery: bool

Whether to enable fail-on-recovery. Should only be used in e2e tests.

disable_automatic_parallelism_control: bool

Whether to disable adaptive-scaling feature.

parallelism_control_batch_size: usize

The number of streaming jobs per scaling operation.

parallelism_control_trigger_period_sec: u64

The period of parallelism control trigger.

parallelism_control_trigger_first_delay_sec: u64

The first delay of parallelism control.

meta_leader_lease_secs: u64

dangerous_max_idle_secs: Option<u64>

After specified seconds of idle (no mview or flush), the process will be exited. It is mainly useful for playgrounds.

default_parallelism: DefaultParallelism

The default global parallelism for all streaming jobs, if user doesn’t specify the parallelism, this value will be used. FULL means use all available parallelism units, otherwise it’s a number.

enable_compaction_deterministic: bool

Whether to enable deterministic compaction scheduling, which will disable all auto scheduling of compaction tasks. Should only be used in e2e tests.

enable_committed_sst_sanity_check: bool

Enable sanity check when SSTs are committed.

node_num_monitor_interval_sec: u64

backend: MetaBackend

periodic_space_reclaim_compaction_interval_sec: u64

Schedule space_reclaim compaction for all compaction groups with this interval.

periodic_ttl_reclaim_compaction_interval_sec: u64

Schedule ttl_reclaim compaction for all compaction groups with this interval.

periodic_tombstone_reclaim_compaction_interval_sec: u64

move_table_size_limit: u64

👎Deprecated

split_group_size_limit: u64

👎Deprecated

cut_table_size_limit: u64

👎Deprecated

unrecognized: Unrecognized<Self>

do_not_config_object_storage_lifecycle: bool

Whether config object storage bucket lifecycle to purge stale data.

partition_vnode_count: u32

Count of partition in split group. Meta will assign this value to every new group when it splits from default-group by automatically. Each partition contains aligned data of vnode_count / partition_vnode_count consecutive virtual-nodes of one state table.

table_high_write_throughput_threshold: u64

The threshold of write throughput to trigger a group split.

table_low_write_throughput_threshold: u64

The threshold of write throughput to trigger a group merge.

compaction_task_max_heartbeat_interval_secs: u64

compaction_task_max_progress_interval_secs: u64

compaction_config: CompactionConfig

hybrid_partition_vnode_count: u32

Count of partitions of tables in default group and materialized view group. The meta node will decide according to some strategy whether to cut the boundaries of the file according to the vnode alignment. Each partition contains aligned data of vnode_count / hybrid_partition_vnode_count consecutive virtual-nodes of one state table. Set it zero to disable this feature.

event_log_enabled: bool

event_log_channel_max_size: u32

Keeps the latest N events per channel.

developer: MetaDeveloperConfig

enable_dropped_column_reclaim: bool

Whether compactor should rewrite row to remove dropped column.

split_group_size_ratio: f64

Whether to split the compaction group when the size of the group exceeds the compaction_group_config.max_estimated_group_size() * split_group_size_ratio.

table_stat_high_write_throughput_ratio_for_split: f64

To split the compaction group when the high throughput statistics of the group exceeds the threshold.

table_stat_low_write_throughput_ratio_for_merge: f64

To merge the compaction group when the low throughput statistics of the group exceeds the threshold.

table_stat_throuput_window_seconds_for_split: usize

The window seconds of table throughput statistic history for split compaction group.

table_stat_throuput_window_seconds_for_merge: usize

The window seconds of table throughput statistic history for merge compaction group.

compact_task_table_size_partition_threshold_low: u64

The threshold of table size in one compact task to decide whether to partition one table into hybrid_partition_vnode_count parts, which belongs to default group and materialized view group. Set it max value of 64-bit number to disable this feature.

compact_task_table_size_partition_threshold_high: u64

The threshold of table size in one compact task to decide whether to partition one table into partition_vnode_count parts, which belongs to default group and materialized view group. Set it max value of 64-bit number to disable this feature.

periodic_scheduling_compaction_group_split_interval_sec: u64

periodic_scheduling_compaction_group_merge_interval_sec: u64

meta_store_config: MetaStoreConfig

Implementations

impl MetaConfig

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

Trait Implementations

impl Clone for MetaConfig

fn clone(&self) -> MetaConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetaConfig

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

Formats the value using the given formatter.

impl Default for MetaConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetaConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MetaConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.