Struct IndexBuildTask 

pub struct IndexBuildTask {

    pub region_id: RegionId,
    pub file: FileHandle,
    pub(crate) target_region_metadata: RegionMetadataRef,
    pub(crate) source: IndexBuildSource,
    pub reason: IndexBuildType,
    pub access_layer: AccessLayerRef,
    pub(crate) listener: WorkerListener,
    pub(crate) manifest_ctx: Arc<ManifestContext>,
    pub write_cache: Option<Arc<WriteCache>>,
    pub cache_manager: Option<CacheManagerRef>,
    pub file_purger: FilePurgerRef,
    pub indexer_builder: Arc<dyn IndexerBuilder + Send + Sync>,
    pub(crate) request_sender: Sender<WorkerRequestWithTime>,
    pub(crate) result_sender: ResultMpscSender,
}

Fields

region_id: RegionId

The logical region whose manifest and in-memory version this task updates.

file: FileHandle

The SST file handle to build index for.

target_region_metadata: RegionMetadataRef

The target region metadata used to decode rows from the SST.

An SST may originate in another region while being visible in the target manifest. This metadata defines the target schema and sequence domain; applying the staging manifest only makes imported files visible. Index rebuild happens later when a flush, compaction, schema change, or manual index build request schedules it.

source: IndexBuildSource

The manifest state this build is based on.

reason: IndexBuildType

access_layer: AccessLayerRef

listener: WorkerListener

manifest_ctx: Arc<ManifestContext>

write_cache: Option<Arc<WriteCache>>

cache_manager: Option<CacheManagerRef>

file_purger: FilePurgerRef

indexer_builder: Arc<dyn IndexerBuilder + Send + Sync>

When write cache is enabled, the indexer builder should be built from the write cache. Otherwise, it should be built from the access layer.

request_sender: Sender<WorkerRequestWithTime>

Request sender to notify the region worker.

result_sender: ResultMpscSender

Index build result sender.

Implementations

impl IndexBuildTask

pub async fn on_success(&self, outcome: IndexBuildOutcome)

Notify the caller the job is success.

pub async fn on_failure(&self, err: Arc<Error>)

Send index build error to waiter.

fn into_index_build_job(self, version_control: Arc<VersionControl>) -> Job

async fn do_index_build(&mut self, version_control: Arc<VersionControl>)

async fn check_sst_file_exists( &self, version_control: &Arc<VersionControl>, ) -> bool

async fn index_build( &mut self, version_control: Arc<VersionControl>, ) -> Result<IndexBuildOutcome>

async fn maybe_upload_index_file( &self, output: IndexOutput, index_file_id: FileId, index_version: u64, ) -> Result<()>

async fn update_manifest( &self, output: IndexOutput, new_index_version: u64, ) -> Result<IndexPublication>

Trait Implementations

impl Clone for IndexBuildTask

fn clone(&self) -> IndexBuildTask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexBuildTask

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

Formats the value using the given formatter.

impl Ord for IndexBuildTask

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IndexBuildTask

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for IndexBuildTask

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for IndexBuildTask