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 not the StateStoreWrite trait 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.

async fn get_inner( &self, key: TableKey<Bytes>, epoch: HummockEpoch, read_options: ReadOptions, ) -> StorageResult<Option<StateStoreKeyedRow>>

Gets the value of a specified key in the table specified in read_options. The result is based on a snapshot corresponding to the given epoch. if key has consistent hash virtual node value, then such value is stored in value_meta

If Ok(Some()) is returned, the key is found. If Ok(None) is returned, the key is not found. If Err() is returned, the searching for the key failed due to other non-EOF errors.

async fn iter_inner( &self, key_range: TableKeyRange, epoch: u64, read_options: ReadOptions, ) -> StorageResult<HummockStorageIterator>

async fn rev_iter_inner( &self, key_range: TableKeyRange, epoch: u64, read_options: ReadOptions, ) -> StorageResult<HummockStorageRevIterator>

async fn get_time_travel_version( &self, epoch: u64, table_id: TableId, ) -> StorageResult<PinnedVersion>

async fn build_read_version_tuple( &self, epoch: u64, key_range: TableKeyRange, read_options: &ReadOptions, ) -> StorageResult<(TableKeyRange, ReadVersionTuple)>

async fn build_read_version_tuple_from_backup( &self, epoch: u64, table_id: TableId, key_range: TableKeyRange, ) -> StorageResult<(TableKeyRange, ReadVersionTuple)>

async fn build_read_version_tuple_from_committed( &self, epoch: u64, table_id: TableId, key_range: TableKeyRange, ) -> StorageResult<(TableKeyRange, ReadVersionTuple)>

fn build_read_version_tuple_from_all( &self, epoch: u64, table_id: TableId, key_range: TableKeyRange, ) -> StorageResult<(TableKeyRange, ReadVersionTuple)>

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

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>

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

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

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

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

impl StateStoreRead for HummockStorage

type ChangeLogIter = ChangeLogIterator

type Iter = HummockStorageIteratorInner<'static>

type RevIter = HummockStorageRevIteratorInner<'static>

fn get_keyed_row( &self, key: TableKey<Bytes>, epoch: u64, read_options: ReadOptions, ) -> impl Future<Output = StorageResult<Option<StateStoreKeyedRow>>> + Send + '_

Point gets a value from the state store. The result is based on a snapshot corresponding to the given epoch. Both full key and the value are returned.

fn iter( &self, key_range: TableKeyRange, epoch: u64, read_options: ReadOptions, ) -> impl Future<Output = StorageResult<Self::Iter>> + '_

Opens and returns an iterator for given prefix_hint and full_key_range Internally, prefix_hint will be used to for checking bloom_filter and full_key_range used for iter. (if the prefix_hint not None, it should be be included in key_range) The returned iterator will iterate data based on a snapshot corresponding to the given epoch.

fn rev_iter( &self, key_range: TableKeyRange, epoch: u64, read_options: ReadOptions, ) -> impl Future<Output = StorageResult<Self::RevIter>> + '_

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

fn get( &self, key: TableKey<Bytes>, epoch: u64, read_options: ReadOptions, ) -> impl Future<Output = StorageResult<Option<Bytes>>> + Send + '_

Point gets a value from the state store. The result is based on a snapshot corresponding to the given epoch. Only the value is returned.