Enum HummockCommands

pub(crate) enum HummockCommands {
    ListVersion {
        verbose: bool,
        verbose_key_range: bool,
    },
    ListVersionDeltas {
        start_id: u64,
        num_epochs: u32,
    },
    DisableCommitEpoch,
    ListKv {
        epoch: u64,
        table_id: u32,
        data_dir: Option<String>,
        use_new_object_prefix_strategy: bool,
    },
    SstDump(SstDumpArgs),
    TriggerManualCompaction {
        compaction_group_id: u64,
        table_id: u32,
        level: u32,
        sst_ids: Vec<u64>,
    },
    TriggerFullGc {
        sst_retention_time_sec: u64,
        prefix: Option<String>,
    },
    ListPinnedVersions {},
    ListCompactionGroup,
    UpdateCompactionConfig {

        compaction_group_ids: Vec<u64>,
        max_bytes_for_level_base: Option<u64>,
        max_bytes_for_level_multiplier: Option<u64>,
        max_compaction_bytes: Option<u64>,
        sub_level_max_compaction_bytes: Option<u64>,
        level0_tier_compact_file_number: Option<u64>,
        target_file_size_base: Option<u64>,
        compaction_filter_mask: Option<u32>,
        max_sub_compaction: Option<u32>,
        level0_stop_write_threshold_sub_level_number: Option<u64>,
        level0_sub_level_compact_level_count: Option<u32>,
        max_space_reclaim_bytes: Option<u64>,
        level0_max_compact_file_number: Option<u64>,
        level0_overlapping_sub_level_compact_level_count: Option<u32>,
        enable_emergency_picker: Option<bool>,
        tombstone_reclaim_ratio: Option<u32>,
        compression_level: Option<u32>,
        compression_algorithm: Option<String>,
        max_l0_compact_level: Option<u32>,
        sst_allowed_trivial_move_min_size: Option<u64>,
        disable_auto_group_scheduling: Option<bool>,
        max_overlapping_level_size: Option<u64>,
        sst_allowed_trivial_move_max_count: Option<u32>,
        emergency_level0_sst_file_count: Option<u32>,
        emergency_level0_sub_level_partition: Option<u32>,
        level0_stop_write_threshold_max_sst_count: Option<u32>,
        level0_stop_write_threshold_max_size: Option<u64>,
    
},
    SplitCompactionGroup {
        compaction_group_id: u64,
        table_ids: Vec<u32>,
        partition_vnode_count: u32,
    },
    PauseVersionCheckpoint,
    ResumeVersionCheckpoint,
    ReplayVersion,
    ListCompactionStatus {
        verbose: bool,
    },
    GetCompactionScore {
        compaction_group_id: u64,
    },
    ValidateVersion,
    RebuildTableStats,
    CancelCompactTask {
        task_id: u64,
    },
    PrintUserKeyInArchive {
        archive_ids: Vec<u64>,
        data_dir: String,
        user_key: String,
        use_new_object_prefix_strategy: bool,
    },
    PrintVersionDeltaInArchive {
        archive_ids: Vec<u64>,
        data_dir: String,
        sst_id: u64,
        use_new_object_prefix_strategy: bool,
    },
    TieredCacheTracing {
        enable: bool,
        record_hybrid_insert_threshold_ms: Option<u32>,
        record_hybrid_get_threshold_ms: Option<u32>,
        record_hybrid_obtain_threshold_ms: Option<u32>,
        record_hybrid_remove_threshold_ms: Option<u32>,
        record_hybrid_fetch_threshold_ms: Option<u32>,
    },
    MergeCompactionGroup {
        left_group_id: u64,
        right_group_id: u64,
    },
    MigrateLegacyObject {
        url: String,
        source_dir: String,
        target_dir: String,
        concurrency: u32,
    },
    ResizeCache {
        meta_cache_capacity_mb: Option<u64>,
        data_cache_capacity_mb: Option<u64>,
    },
}

Variants

ListVersion

list latest Hummock version on meta node

Fields

verbose: bool

verbose_key_range: bool

ListVersionDeltas

list hummock version deltas in the meta store

Fields

start_id: u64

num_epochs: u32

DisableCommitEpoch

Forbid hummock commit new epochs, which is a prerequisite for compaction deterministic test

ListKv

list all Hummock key-value pairs

Fields

epoch: u64

table_id: u32

data_dir: Option<String>

use_new_object_prefix_strategy: bool

SstDump(SstDumpArgs)

TriggerManualCompaction

trigger a targeted compaction through compaction_group_id

Fields

compaction_group_id: u64

table_id: u32

level: u32

sst_ids: Vec<u64>

TriggerFullGc

Trigger a full GC for SSTs that is not pinned, with timestamp <= now - sst_retention_time_sec, and with prefix in path.

Fields

sst_retention_time_sec: u64

prefix: Option<String>

ListPinnedVersions

List pinned versions of each worker.

ListCompactionGroup

List all compaction groups.

UpdateCompactionConfig

Update compaction config for compaction groups.

Fields

compaction_group_ids: Vec<u64>

max_bytes_for_level_base: Option<u64>

max_bytes_for_level_multiplier: Option<u64>

max_compaction_bytes: Option<u64>

sub_level_max_compaction_bytes: Option<u64>

level0_tier_compact_file_number: Option<u64>

target_file_size_base: Option<u64>

compaction_filter_mask: Option<u32>

max_sub_compaction: Option<u32>

level0_stop_write_threshold_sub_level_number: Option<u64>

level0_sub_level_compact_level_count: Option<u32>

max_space_reclaim_bytes: Option<u64>

level0_max_compact_file_number: Option<u64>

level0_overlapping_sub_level_compact_level_count: Option<u32>

enable_emergency_picker: Option<bool>

tombstone_reclaim_ratio: Option<u32>

compression_level: Option<u32>

compression_algorithm: Option<String>

max_l0_compact_level: Option<u32>

sst_allowed_trivial_move_min_size: Option<u64>

disable_auto_group_scheduling: Option<bool>

max_overlapping_level_size: Option<u64>

sst_allowed_trivial_move_max_count: Option<u32>

emergency_level0_sst_file_count: Option<u32>

emergency_level0_sub_level_partition: Option<u32>

level0_stop_write_threshold_max_sst_count: Option<u32>

level0_stop_write_threshold_max_size: Option<u64>

SplitCompactionGroup

Split given compaction group into two. Moves the given tables to the new group.

Fields

compaction_group_id: u64

table_ids: Vec<u32>

partition_vnode_count: u32

PauseVersionCheckpoint

Pause version checkpoint, which subsequently pauses GC of delta log and SST object.

ResumeVersionCheckpoint

Resume version checkpoint, which subsequently resumes GC of delta log and SST object.

ReplayVersion

Replay version from the checkpoint one to the latest one.

ListCompactionStatus

List compaction status

Fields

verbose: bool

GetCompactionScore

Fields

compaction_group_id: u64

ValidateVersion

Validate the current HummockVersion.

RebuildTableStats

Rebuild table stats

CancelCompactTask

Fields

task_id: u64

PrintUserKeyInArchive

Fields

archive_ids: Vec<u64>

The ident of the archive file in object store. It’s also the first Hummock version id of this archive.

data_dir: String

The data directory of Hummock storage, where SSTable objects can be found.

user_key: String

KVs that are matched with the user key are printed.

use_new_object_prefix_strategy: bool

PrintVersionDeltaInArchive

Fields

archive_ids: Vec<u64>

The ident of the archive file in object store. It’s also the first Hummock version id of this archive.

data_dir: String

The data directory of Hummock storage, where SSTable objects can be found.

sst_id: u64

Version deltas that are related to the SST id are printed.

use_new_object_prefix_strategy: bool

TieredCacheTracing

Fields

enable: bool

record_hybrid_insert_threshold_ms: Option<u32>

record_hybrid_get_threshold_ms: Option<u32>

record_hybrid_obtain_threshold_ms: Option<u32>

record_hybrid_remove_threshold_ms: Option<u32>

record_hybrid_fetch_threshold_ms: Option<u32>

MergeCompactionGroup

Fields

left_group_id: u64

right_group_id: u64

MigrateLegacyObject

Fields

url: String

source_dir: String

target_dir: String

concurrency: u32

ResizeCache

Fields

meta_cache_capacity_mb: Option<u64>

data_cache_capacity_mb: Option<u64>

Trait Implementations

impl FromArgMatches for HummockCommands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for HummockCommands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand