risingwave_rpc_client/
hummock_meta_client.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use async_trait::async_trait;
16use futures::stream::BoxStream;
17use risingwave_hummock_sdk::version::HummockVersion;
18use risingwave_hummock_sdk::{HummockEpoch, HummockVersionId, SstObjectIdRange, SyncResult};
19use risingwave_pb::hummock::{
20    PbHummockVersion, SubscribeCompactionEventRequest, SubscribeCompactionEventResponse,
21};
22use tokio::sync::mpsc::UnboundedSender;
23
24pub type CompactionEventItem = std::result::Result<SubscribeCompactionEventResponse, tonic::Status>;
25
26use crate::error::Result;
27
28pub type HummockMetaClientChangeLogInfo = Vec<u64>;
29
30#[async_trait]
31pub trait HummockMetaClient: Send + Sync + 'static {
32    async fn unpin_version_before(&self, unpin_version_before: HummockVersionId) -> Result<()>;
33    async fn get_current_version(&self) -> Result<HummockVersion>;
34    async fn get_new_sst_ids(&self, number: u32) -> Result<SstObjectIdRange>;
35    // We keep `commit_epoch` only for test/benchmark.
36    async fn commit_epoch_with_change_log(
37        &self,
38        epoch: HummockEpoch,
39        sync_result: SyncResult,
40        change_log_info: Option<HummockMetaClientChangeLogInfo>,
41    ) -> Result<()>;
42    async fn commit_epoch(&self, epoch: HummockEpoch, sync_result: SyncResult) -> Result<()> {
43        self.commit_epoch_with_change_log(epoch, sync_result, None)
44            .await
45    }
46    async fn trigger_manual_compaction(
47        &self,
48        compaction_group_id: u64,
49        table_id: u32,
50        level: u32,
51        sst_ids: Vec<u64>,
52    ) -> Result<()>;
53    async fn trigger_full_gc(
54        &self,
55        sst_retention_time_sec: u64,
56        prefix: Option<String>,
57    ) -> Result<()>;
58
59    async fn subscribe_compaction_event(
60        &self,
61    ) -> Result<(
62        UnboundedSender<SubscribeCompactionEventRequest>,
63        BoxStream<'static, CompactionEventItem>,
64    )>;
65
66    async fn get_version_by_epoch(
67        &self,
68        epoch: HummockEpoch,
69        table_id: u32,
70    ) -> Result<PbHummockVersion>;
71}
risingwave_rpc_client/hummock_meta_client.rs

risingwave_rpc_client/
hummock_meta_client.rs
