Struct MitoEngine 

pub struct MitoEngine {
    inner: Arc<EngineInner>,
}

Region engine implementation for timeseries data.

Fields

inner: Arc<EngineInner>

Implementations

impl MitoEngine

pub async fn new<S: LogStore>( data_home: &str, config: MitoConfig, log_store: Arc<S>, object_store_manager: ObjectStoreManagerRef, schema_metadata_manager: SchemaMetadataManagerRef, file_ref_manager: FileReferenceManagerRef, partition_expr_fetcher: PartitionExprFetcherRef, plugins: Plugins, ) -> Result<MitoEngine>

Returns a new MitoEngine with specific config, log_store and object_store.

pub fn mito_config(&self) -> &MitoConfig

pub fn cache_manager(&self) -> CacheManagerRef

pub fn file_ref_manager(&self) -> FileReferenceManagerRef

pub fn gc_limiter(&self) -> GcLimiterRef

pub async fn get_snapshot_of_unmanifested_refs( &self, region_ids: impl IntoIterator<Item = RegionId>, ) -> Result<FileRefsManifest>

Get all tmp ref files for given region ids, excluding files that’s already in manifest.

pub fn is_region_exists(&self, region_id: RegionId) -> bool

Returns true if the specific region exists.

pub fn is_region_opening(&self, region_id: RegionId) -> bool

Returns true if the specific region exists.

pub fn is_region_catching_up(&self, region_id: RegionId) -> bool

Returns true if the specific region is catching up.

pub fn get_region_statistic( &self, region_id: RegionId, ) -> Option<RegionStatistic>

Returns the region disk/memory statistic.

pub fn get_primary_key_encoding( &self, region_id: RegionId, ) -> Option<PrimaryKeyEncoding>

Returns primary key encoding of the region.

pub async fn scan_to_stream( &self, region_id: RegionId, request: ScanRequest, ) -> Result<SendableRecordBatchStream, BoxedError>

Handle substrait query and return a stream of record batches

Notice that the output stream’s ordering is not guranateed. If order matter, please use [scanner] to build a Scanner to consume.

pub async fn scan_batch( &self, region_id: RegionId, request: ScanRequest, filter_deleted: bool, ) -> Result<ScanBatchStream>

Scan [Batch]es by ScanRequest.

async fn scanner( &self, region_id: RegionId, request: ScanRequest, ) -> Result<Scanner>

Returns a scanner to scan for request.

fn scan_region( &self, region_id: RegionId, request: ScanRequest, ) -> Result<ScanRegion>

Scans a region.

pub async fn edit_region( &self, region_id: RegionId, edit: RegionEdit, ) -> Result<()>

Edit region’s metadata by RegionEdit directly. Use with care. Now we only allow adding files to region (the RegionEdit struct can only contain a non-empty “files_to_add” field). Other region editing intention will result in an “invalid request” error. Also note that if a region is to be edited directly, we MUST not write data to it thereafter.

pub fn find_region(&self, region_id: RegionId) -> Option<MitoRegionRef>

fn encode_manifest_info_to_extensions( region_id: &RegionId, manifest_info: RegionManifestInfo, extensions: &mut HashMap<String, Vec<u8>>, ) -> Result<()>

fn encode_column_metadatas_to_extensions( region_id: &RegionId, column_metadatas: Vec<ColumnMetadata>, extensions: &mut HashMap<String, Vec<u8>>, ) -> Result<()>

pub fn find_memtable_and_sst_stats( &self, region_id: RegionId, ) -> Result<(Vec<MemtableStats>, Vec<FileMeta>)>

Find the current version’s memtables and SSTs stats by region_id. The stats must be collected in one place one time to ensure data consistency.

pub async fn all_ssts_from_manifest(&self) -> Vec<ManifestSstEntry>

Lists all SSTs from the manifest of all regions in the engine.

pub async fn all_index_metas(&self) -> Vec<PuffinIndexMetaEntry>

Lists metadata about all puffin index targets stored in the engine.

pub fn all_ssts_from_storage( &self, ) -> impl Stream<Item = Result<StorageSstEntry>>

Lists all SSTs from the storage layer of all regions in the engine.

impl MitoEngine

fn handle_alter_response( &self, region_id: RegionId, response: &mut RegionResponse, ) -> Result<()>

fn handle_create_response( &self, region_id: RegionId, response: &mut RegionResponse, ) -> Result<()>

Trait Implementations

impl Clone for MitoEngine

fn clone(&self) -> MitoEngine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl RegionEngine for MitoEngine

fn get_metadata<'life0, 'async_trait>( &'life0 self, region_id: RegionId, ) -> Pin<Box<dyn Future<Output = Result<RegionMetadataRef, BoxedError>> + Send + 'async_trait>>

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

Retrieve region’s metadata.

fn stop<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), BoxedError>> + Send + 'async_trait>>

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

Stop the engine.

Stopping the engine doesn’t stop the underlying log store as other components might still use it. (When no other components are referencing the log store, it will automatically shutdown.)

fn name(&self) -> &str

Name of this engine

fn handle_batch_open_requests<'life0, 'async_trait>( &'life0 self, parallelism: usize, requests: Vec<(RegionId, RegionOpenRequest)>, ) -> Pin<Box<dyn Future<Output = Result<BatchResponses, BoxedError>> + Send + 'async_trait>>

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

Handles batch open region requests.

fn handle_batch_catchup_requests<'life0, 'async_trait>( &'life0 self, parallelism: usize, requests: Vec<(RegionId, RegionCatchupRequest)>, ) -> Pin<Box<dyn Future<Output = Result<BatchResponses, BoxedError>> + Send + 'async_trait>>

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

fn handle_request<'life0, 'async_trait>( &'life0 self, region_id: RegionId, request: RegionRequest, ) -> Pin<Box<dyn Future<Output = Result<RegionResponse, BoxedError>> + Send + 'async_trait>>

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

Handles non-query request to the region. Returns the count of affected rows.

fn handle_query<'life0, 'async_trait>( &'life0 self, region_id: RegionId, request: ScanRequest, ) -> Pin<Box<dyn Future<Output = Result<RegionScannerRef, BoxedError>> + Send + 'async_trait>>

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

Handles query and return a scanner that can be used to scan the region concurrently.

fn get_committed_sequence<'life0, 'async_trait>( &'life0 self, region_id: RegionId, ) -> Pin<Box<dyn Future<Output = Result<SequenceNumber, BoxedError>> + Send + 'async_trait>>

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

Returns the committed sequence (sequence of latest written data).

fn region_statistic(&self, region_id: RegionId) -> Option<RegionStatistic>

Retrieves region’s statistic.

fn set_region_role( &self, region_id: RegionId, role: RegionRole, ) -> Result<(), BoxedError>

Sets RegionRole for a region.

fn set_region_role_state_gracefully<'life0, 'async_trait>( &'life0 self, region_id: RegionId, region_role_state: SettableRegionRoleState, ) -> Pin<Box<dyn Future<Output = Result<SetRegionRoleStateResponse, BoxedError>> + Send + 'async_trait>>

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

Sets region role state gracefully.

fn sync_region<'life0, 'async_trait>( &'life0 self, region_id: RegionId, manifest_info: RegionManifestInfo, ) -> Pin<Box<dyn Future<Output = Result<SyncManifestResponse, BoxedError>> + Send + 'async_trait>>

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

Syncs the region manifest to the given manifest version.

fn role(&self, region_id: RegionId) -> Option<RegionRole>

Indicates region role.

fn as_any(&self) -> &dyn Any

fn handle_batch_ddl_requests<'life0, 'async_trait>( &'life0 self, request: BatchRegionDdlRequest, ) -> Pin<Box<dyn Future<Output = Result<RegionResponse, BoxedError>> + Send + 'async_trait>>

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