Struct RegionManifestManager

pub struct RegionManifestManager {
    store: ManifestObjectStore,
    last_version: Arc<AtomicU64>,
    checkpointer: Checkpointer,
    manifest: Arc<RegionManifest>,
    stopped: bool,
}

Manage region’s manifest. Provide APIs to access (create/modify/recover) region’s persisted metadata.

classDiagram class RegionManifestManager { -ManifestObjectStore store -RegionManifestOptions options -RegionManifest manifest +new() RegionManifestManager +open() Option~RegionManifestManager~ +stop() +update(RegionMetaActionList action_list) ManifestVersion +manifest() RegionManifest } class ManifestObjectStore { -ObjectStore object_store } class RegionChange { -RegionMetadataRef metadata } class RegionEdit { -VersionNumber regoin_version -Vec~FileMeta~ files_to_add -Vec~FileMeta~ files_to_remove -SequenceNumber flushed_sequence } class RegionRemove { -RegionId region_id } RegionManifestManager o-- ManifestObjectStore RegionManifestManager o-- RegionManifest RegionManifestManager o-- RegionManifestOptions RegionManifestManager -- RegionMetaActionList RegionManifestManager -- RegionCheckpoint ManifestObjectStore o-- ObjectStore RegionMetaActionList o-- RegionMetaAction RegionMetaAction o-- ProtocolAction RegionMetaAction o-- RegionChange RegionMetaAction o-- RegionEdit RegionMetaAction o-- RegionRemove RegionChange o-- RegionMetadata RegionEdit o-- FileMeta class RegionManifest { -RegionMetadataRef metadata -HashMap<FileId, FileMeta> files -ManifestVersion manifest_version } class RegionMetadata class FileMeta RegionManifest o-- RegionMetadata RegionManifest o-- FileMeta class RegionCheckpoint { -ManifestVersion last_version -Option~RegionManifest~ checkpoint } RegionCheckpoint o-- RegionManifest

Fields

store: ManifestObjectStore

last_version: Arc<AtomicU64>

checkpointer: Checkpointer

manifest: Arc<RegionManifest>

stopped: bool

Implementations

impl RegionManifestManager

pub async fn new( metadata: RegionMetadataRef, options: RegionManifestOptions, total_manifest_size: Arc<AtomicU64>, manifest_version: Arc<AtomicU64>, ) -> Result<Self>

Constructs a region’s manifest and persist it.

pub async fn open( options: RegionManifestOptions, total_manifest_size: Arc<AtomicU64>, manifest_version: Arc<AtomicU64>, ) -> Result<Option<Self>>

Opens an existing manifest.

Returns Ok(None) if no such manifest.

pub async fn stop(&mut self)

Stops the manager.

pub async fn install_manifest_to( &mut self, target_version: ManifestVersion, ) -> Result<ManifestVersion>

Installs the manifest changes from the current version to the target version (inclusive).

Returns installed version. Note: This function is not guaranteed to install the target version strictly. The installed version may be greater than the target version.

pub(crate) async fn install_last_checkpoint( &mut self, ) -> Result<ManifestVersion>

Installs the last checkpoint.

pub async fn update( &mut self, action_list: RegionMetaActionList, ) -> Result<ManifestVersion>

Updates the manifest. Returns the current manifest version number.

pub fn manifest(&self) -> Arc<RegionManifest>

Retrieves the current RegionManifest.

pub fn manifest_usage(&self) -> u64

Returns total manifest size.

pub async fn has_update(&self) -> Result<bool>

Returns true if a newer version manifest file is found.

It is typically used in read-only regions to catch up with manifest. It doesn’t lock the manifest directory in the object store so the result may be inaccurate if there are concurrent writes.

fn increase_version(&mut self) -> ManifestVersion

Increases last version and returns the increased version.

fn set_version(&mut self, version: ManifestVersion) -> ManifestVersion

Sets the last version.

fn last_version(&self) -> ManifestVersion

pub(crate) async fn last_checkpoint( store: &mut ManifestObjectStore, ) -> Result<Option<(RegionCheckpoint, u64)>>

Fetches the last RegionCheckpoint from storage.

If the checkpoint is not found, returns None. Otherwise, returns the checkpoint and the size of the checkpoint.

Trait Implementations

impl Debug for RegionManifestManager

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

Formats the value using the given formatter.