Struct RegionOpener

pub(crate) struct RegionOpener {

    region_id: RegionId,
    metadata_builder: Option<RegionMetadataBuilder>,
    memtable_builder_provider: MemtableBuilderProvider,
    object_store_manager: ObjectStoreManagerRef,
    table_dir: String,
    path_type: PathType,
    purge_scheduler: SchedulerRef,
    options: Option<RegionOptions>,
    cache_manager: Option<CacheManagerRef>,
    skip_wal_replay: bool,
    puffin_manager_factory: PuffinManagerFactory,
    intermediate_manager: IntermediateManager,
    time_provider: Arc<dyn TimeProvider>,
    stats: ManifestStats,
    wal_entry_reader: Option<Box<dyn WalEntryReader>>,
}

Builder to create a new MitoRegion or open an existing one.

Fields

region_id: RegionId

metadata_builder: Option<RegionMetadataBuilder>

memtable_builder_provider: MemtableBuilderProvider

object_store_manager: ObjectStoreManagerRef

table_dir: String

path_type: PathType

purge_scheduler: SchedulerRef

options: Option<RegionOptions>

cache_manager: Option<CacheManagerRef>

skip_wal_replay: bool

puffin_manager_factory: PuffinManagerFactory

intermediate_manager: IntermediateManager

time_provider: Arc<dyn TimeProvider>

stats: ManifestStats

wal_entry_reader: Option<Box<dyn WalEntryReader>>

Implementations

impl RegionOpener

pub(crate) fn new( region_id: RegionId, table_dir: &str, path_type: PathType, memtable_builder_provider: MemtableBuilderProvider, object_store_manager: ObjectStoreManagerRef, purge_scheduler: SchedulerRef, puffin_manager_factory: PuffinManagerFactory, intermediate_manager: IntermediateManager, time_provider: Arc<dyn TimeProvider>, ) -> RegionOpener

Returns a new opener.

pub(crate) fn metadata_builder(self, builder: RegionMetadataBuilder) -> Self

Sets metadata builder of the region to create.

fn region_dir(&self) -> String

Computes the region directory from table_dir and region_id.

fn build_metadata(&mut self) -> Result<RegionMetadata>

Builds the region metadata.

Panics

• Panics if options is not set.
• Panics if metadata_builder is not set.

pub(crate) fn parse_options( self, options: HashMap<String, String>, ) -> Result<Self>

Parses and sets options for the region.

pub(crate) fn wal_entry_reader( self, wal_entry_reader: Option<Box<dyn WalEntryReader>>, ) -> Self

If a WalEntryReader is set, the RegionOpener will use WalEntryReader instead of constructing a new one from scratch.

pub(crate) fn options(self, options: RegionOptions) -> Result<Self>

Sets options for the region.

pub(crate) fn cache(self, cache_manager: Option<CacheManagerRef>) -> Self

Sets the cache manager for the region.

pub(crate) fn skip_wal_replay(self, skip: bool) -> Self

Sets the skip_wal_replay.

pub(crate) async fn create_or_open<S: LogStore>( self, config: &MitoConfig, wal: &Wal<S>, ) -> Result<MitoRegion>

Writes region manifest and creates a new region if it does not exist. Opens the region if it already exists.

Panics

• Panics if metadata_builder is not set.
• Panics if options is not set.

pub(crate) async fn open<S: LogStore>( self, config: &MitoConfig, wal: &Wal<S>, ) -> Result<MitoRegion>

Opens an existing region in read only mode.

Returns error if the region doesn’t exist.

fn provider<S: LogStore>(&self, wal_options: &WalOptions) -> Result<Provider>

async fn maybe_open<S: LogStore>( &mut self, config: &MitoConfig, wal: &Wal<S>, ) -> Result<Option<MitoRegion>>

Tries to open the region and returns None if the region directory is empty.

fn manifest_options( config: &MitoConfig, options: &RegionOptions, region_dir: &str, object_store_manager: &ObjectStoreManagerRef, ) -> Result<RegionManifestOptions>

Returns a new manifest options.