Struct HummockStorage

pub struct HummockStorage {

    hummock_event_sender: HummockEventSender,
    _version_update_sender: UnboundedSender<HummockVersionUpdate>,
    context: CompactorContext,
    compaction_catalog_manager_ref: CompactionCatalogManagerRef,
    sstable_object_id_manager: SstableObjectIdManagerRef,
    buffer_tracker: BufferTracker,
    version_update_notifier_tx: Arc<Sender<PinnedVersion>>,
    recent_versions: Arc<ArcSwap<RecentVersions>>,
    hummock_version_reader: HummockVersionReader,
    _shutdown_guard: Arc<HummockStorageShutdownGuard>,
    read_version_mapping: ReadOnlyReadVersionMapping,
    backup_reader: BackupReaderRef,
    write_limiter: WriteLimiterRef,
    compact_await_tree_reg: Option<CompactionAwaitTreeRegRef>,
    hummock_meta_client: Arc<dyn HummockMetaClient>,
    simple_time_travel_version_cache: Arc<SimpleTimeTravelVersionCache>,
}

HummockStorage is the entry point of the Hummock state store backend. It implements the StateStore and StateStoreRead traits but without any write method since all writes should be done via LocalHummockStorage to ensure the single writer property of hummock. LocalHummockStorage instance can be created via new_local call. Hummock is the state store backend.

Fields

hummock_event_sender: HummockEventSender

_version_update_sender: UnboundedSender<HummockVersionUpdate>

context: CompactorContext

compaction_catalog_manager_ref: CompactionCatalogManagerRef

sstable_object_id_manager: SstableObjectIdManagerRef

buffer_tracker: BufferTracker

version_update_notifier_tx: Arc<Sender<PinnedVersion>>

recent_versions: Arc<ArcSwap<RecentVersions>>

hummock_version_reader: HummockVersionReader

_shutdown_guard: Arc<HummockStorageShutdownGuard>

read_version_mapping: ReadOnlyReadVersionMapping

backup_reader: BackupReaderRef

write_limiter: WriteLimiterRef

compact_await_tree_reg: Option<CompactionAwaitTreeRegRef>

hummock_meta_client: Arc<dyn HummockMetaClient>

simple_time_travel_version_cache: Arc<SimpleTimeTravelVersionCache>

Implementations

impl HummockStorage

pub async fn new( options: Arc<StorageOpts>, sstable_store: SstableStoreRef, hummock_meta_client: Arc<dyn HummockMetaClient>, notification_client: impl NotificationClient, compaction_catalog_manager_ref: CompactionCatalogManagerRef, state_store_metrics: Arc<HummockStateStoreMetrics>, compactor_metrics: Arc<CompactorMetrics>, await_tree_config: Option<Config>, ) -> HummockResult<Self>

Creates a HummockStorage.

impl HummockStorage

async fn new_local_inner(&self, option: NewLocalOptions) -> LocalHummockStorage

pub async fn clear_shared_buffer(&self)

pub async fn clear_tables(&self, table_ids: HashSet<TableId>)

pub fn start_epoch(&self, epoch: HummockEpoch, table_ids: HashSet<TableId>)

Declare the start of an epoch. This information is provided for spill so that the spill task won’t include data of two or more syncs.

pub fn sstable_store(&self) -> SstableStoreRef

pub fn sstable_object_id_manager(&self) -> &SstableObjectIdManagerRef

pub fn compaction_catalog_manager_ref(&self) -> CompactionCatalogManagerRef

pub fn get_memory_limiter(&self) -> Arc<MemoryLimiter>

pub fn get_pinned_version(&self) -> PinnedVersion

pub fn backup_reader(&self) -> BackupReaderRef

pub fn compaction_await_tree_reg(&self) -> Option<&Registry>

pub async fn min_uncommitted_sst_id(&self) -> Option<HummockSstableObjectId>

pub async fn sync( &self, sync_table_epochs: Vec<(HummockEpoch, HashSet<TableId>)>, ) -> StorageResult<SyncResult>

impl HummockStorage

async fn try_wait_epoch_impl( &self, wait_epoch: HummockReadEpoch, table_id: TableId, ) -> StorageResult<()>

Waits until the local hummock version contains the epoch. If wait_epoch is Current, we will only check whether it is le sealed_epoch and won’t wait.

impl HummockStorage

pub async fn seal_and_sync_epoch( &self, epoch: u64, table_ids: HashSet<TableId>, ) -> StorageResult<SyncResult>

pub async fn update_version_and_wait(&self, version: HummockVersion)

Used in the compaction test tool

pub async fn wait_version(&self, version: HummockVersion)

pub fn get_shared_buffer_size(&self) -> usize

pub async fn for_test( options: Arc<StorageOpts>, sstable_store: SstableStoreRef, hummock_meta_client: Arc<dyn HummockMetaClient>, notification_client: impl NotificationClient, ) -> HummockResult<Self>

Creates a HummockStorage with default stats. Should only be used by tests.

pub fn storage_opts(&self) -> &Arc<StorageOpts>

pub fn version_reader(&self) -> &HummockVersionReader

pub async fn wait_version_update( &self, old_id: HummockVersionId, ) -> HummockVersionId

Trait Implementations

impl AsHummock for HummockStorage

fn as_hummock(&self) -> Option<&HummockStorage>

fn sync( &self, sync_table_epochs: Vec<(HummockEpoch, HashSet<TableId>)>, ) -> BoxFuture<'_, StorageResult<SyncResult>>

impl Clone for HummockStorage

fn clone(&self) -> HummockStorage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl StateStore for HummockStorage

async fn try_wait_epoch( &self, wait_epoch: HummockReadEpoch, options: TryWaitEpochOptions, ) -> StorageResult<()>

Waits until the local hummock version contains the epoch. If wait_epoch is Current, we will only check whether it is le sealed_epoch and won’t wait.

type Local = LocalHummockStorage

type ReadSnapshot = HummockStorageReadSnapshot

fn new_local( &self, option: NewLocalOptions, ) -> impl Future<Output = Self::Local> + Send + '_

async fn new_read_snapshot( &self, epoch: HummockReadEpoch, options: NewReadSnapshotOptions, ) -> StorageResult<Self::ReadSnapshot>

fn monitored( self, storage_metrics: Arc<MonitoredStorageMetrics>, ) -> MonitoredStateStore<Self>

Creates a MonitoredStateStore from this state store, with given stats.

impl StateStoreReadLog for HummockStorage

type ChangeLogIter = ChangeLogIterator

async fn next_epoch( &self, epoch: u64, options: NextEpochOptions, ) -> StorageResult<u64>

async fn iter_log( &self, epoch_range: (u64, u64), key_range: TableKeyRange, options: ReadLogOptions, ) -> StorageResult<Self::ChangeLogIter>