Struct BatchGcProcedure 

pub struct BatchGcProcedure {
    mailbox: MailboxRef,
    table_metadata_manager: TableMetadataManagerRef,
    data: BatchGcData,
}

Procedure to perform get file refs then batch GC for multiple regions, it holds locks for all regions during the whole procedure.

Fields

mailbox: MailboxRef

table_metadata_manager: TableMetadataManagerRef

data: BatchGcData

Implementations

impl BatchGcProcedure

pub const TYPE_NAME: &'static str = "metasrv-procedure::BatchGcProcedure"

pub fn new( mailbox: MailboxRef, table_metadata_manager: TableMetadataManagerRef, server_addr: String, regions: Vec<RegionId>, full_file_listing: bool, timeout: Duration, region_routes_override: Region2Peers, ) -> Self

pub fn new_update_repartition_for_test( mailbox: MailboxRef, table_metadata_manager: TableMetadataManagerRef, server_addr: String, regions: Vec<RegionId>, file_refs: FileRefsManifest, timeout: Duration, ) -> Self

Test-only constructor to jump directly into the repartition update state. Intended for integration tests that validate cleanup_region_repartition without running the full batch GC state machine.

pub fn cast_result(res: Arc<dyn Any>) -> Result<GcReport>

async fn get_table_route( &self, table_id: TableId, ) -> Result<(TableId, PhysicalTableRouteValue)>

async fn find_related_regions( &self, regions: &[RegionId], ) -> Result<HashMap<RegionId, HashSet<RegionId>>>

Return related regions for the given regions. The returned map uses the input region as key, and all other regions from the same table as values (excluding the input region itself).

async fn cleanup_region_repartition( &self, procedure_ctx: &ProcedureContext, ) -> Result<()>

Clean up region repartition info in kvbackend after GC according to cross reference in FileRefsManifest.

async fn discover_route_for_regions( &self, regions: &[RegionId], ) -> Result<(Region2Peers, HashMap<Peer, HashSet<RegionId>>)>

Discover region routes for the given regions.

async fn set_routes_and_related_regions(&mut self) -> Result<()>

Set region routes and related regions for GC procedure

async fn get_file_references(&mut self) -> Result<FileRefsManifest>

Get file references from all datanodes that host the regions

async fn send_gc_instructions(&self) -> Result<GcReport>

Send GC instruction to all datanodes that host the regions, returns regions that need retry.

Trait Implementations

impl Procedure for BatchGcProcedure

fn lock_key(&self) -> LockKey

Read lock all regions involved in this GC procedure. So i.e. region migration won’t happen during GC and cause race conditions.

fn type_name(&self) -> &str

Type name of the procedure.

fn execute<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 ProcedureContext, ) -> Pin<Box<dyn Future<Output = ProcedureResult<Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute the procedure.

fn dump(&self) -> ProcedureResult<String>

Dump the state of the procedure to a string.

fn rollback<'life0, 'life1, 'async_trait>( &'life0 mut self, _: &'life1 Context, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Rollback the failed procedure.

fn rollback_supported(&self) -> bool

Indicates whether it supports rolling back the procedure.

fn recover(&mut self) -> Result<(), Error>

The hook is called after the procedure recovery.

fn poison_keys(&self) -> PoisonKeys

Returns the [PoisonKeys] that may cause this procedure to become poisoned during execution.

fn user_metadata(&self) -> Option<UserMetadata>

Returns the user metadata of the procedure. If the metadata contains the eventable object, you can use [UserMetadata::to_event] to get the event and emit it to the event recorder.