Struct tikv::server::gc_worker::compaction_filter::WriteCompactionFilter

struct WriteCompactionFilter {
    safe_point: u64,
    engine: RocksEngine,
    is_bottommost_level: bool,
    encountered_errors: bool,
    write_batch: RocksWriteBatch,
    gc_scheduler: FutureScheduler<GcTask>,
    mvcc_deletions: Vec<Key>,
    mvcc_deletion_overlaps: Option<usize>,
    regions_provider: (u64, Arc<dyn RegionInfoProvider>),
    mvcc_key_prefix: Vec<u8>,
    remove_older: bool,
    versions: usize,
    filtered: usize,
    total_versions: usize,
    total_filtered: usize,
    mvcc_rollback_and_locks: usize,
    orphan_versions: usize,
    versions_hist: LocalHistogram,
    filtered_hist: LocalHistogram,
}

Fields

safe_point: u64

engine: RocksEngine

is_bottommost_level: bool

encountered_errors: bool

write_batch: RocksWriteBatch

gc_scheduler: FutureScheduler<GcTask>

mvcc_deletions: Vec<Key>

mvcc_deletion_overlaps: Option<usize>

regions_provider: (u64, Arc<dyn RegionInfoProvider>)

mvcc_key_prefix: Vec<u8>

remove_older: bool

versions: usize

filtered: usize

total_versions: usize

total_filtered: usize

mvcc_rollback_and_locks: usize

orphan_versions: usize

versions_hist: LocalHistogram

filtered_hist: LocalHistogram

Implementations

impl WriteCompactionFilter

fn new(
    engine: RocksEngine,
    safe_point: u64,
    context: &CompactionFilterContext,
    gc_scheduler: FutureScheduler<GcTask>,
    regions_provider: (u64, Arc<dyn RegionInfoProvider>)
) -> Self

fn schedule_gc_task(&self, task: GcTask, log_on_error: bool)

fn handle_bottommost_delete(&mut self)

fn gc_mvcc_deletions(&mut self)

fn do_filter(
    &mut self,
    _start_level: usize,
    key: &[u8],
    _sequence: u64,
    value: &[u8],
    value_type: CompactionFilterValueType
) -> Result<CompactionFilterDecision, String>

fn handle_filtered_write(&mut self, write: WriteRef<'_>) -> Result<(), String>

fn flush_pending_writes_if_need(&mut self, force: bool) -> Result<(), Error>

fn switch_key_metrics(&mut self)

fn flush_metrics(&self)

Trait Implementations

impl CompactionFilter for WriteCompactionFilter

fn featured_filter(
    &mut self,
    level: usize,
    key: &[u8],
    sequence: u64,
    value: &[u8],
    value_type: CompactionFilterValueType
) -> CompactionFilterDecision

This method will overwrite filter if a CompactionFilter implements both of them.

pub fn filter(
    &mut self,
    _level: usize,
    _key: &[u8],
    _value: &[u8],
    _new_value: &mut Vec<u8, Global>,
    _value_changed: &mut bool
) -> bool

The compaction process invokes this method for kv that is being compacted. A return value of false indicates that the kv should be preserved in the output of this compaction run and a return value of true indicates that this key-value should be removed from the output of the compaction. The application can inspect the existing value of the key and make decision based on it.

impl Drop for WriteCompactionFilter

fn drop(&mut self)

Executes the destructor for this type.