Struct MetaClient 

pub struct MetaClient {
    id: Id,
    channel_manager: ChannelManager,
    leader_provider_factory: Arc<dyn LeaderProviderFactory>,
    heartbeat: Option<Client>,
    config: Option<Client>,
    store: Option<Client>,
    procedure: Option<Client>,
    cluster: Option<Client>,
    region_follower: Option<RegionFollowerClientRef>,
}

Fields

id: Id

channel_manager: ChannelManager

leader_provider_factory: Arc<dyn LeaderProviderFactory>

heartbeat: Option<Client>

config: Option<Client>

store: Option<Client>

procedure: Option<Client>

cluster: Option<Client>

region_follower: Option<RegionFollowerClientRef>

Implementations

impl MetaClient

pub fn new(id: Id, role: Role) -> Self

impl MetaClient

pub async fn start<U, A>(&mut self, urls: A) -> Result<()>

where U: AsRef<str>, A: AsRef<[U]> + Clone,

pub(crate) async fn start_with<U, A>( &mut self, leader_provider: LeaderProviderRef, peers: A, ) -> Result<()>

where U: AsRef<str>, A: AsRef<[U]> + Clone,

Start the client with a LeaderProvider and other Metasrv peers’ addresses.

pub async fn ask_leader(&self) -> Result<String>

Ask the leader address of metasrv, and the heartbeat component needs to create a bidirectional streaming to the leader.

pub async fn pull_config<T, U>(&self, deserializer: T) -> Result<U>

where T: PluginOptionsDeserializer<U>, U: DeserializeOwned,

pub async fn heartbeat( &self, ) -> Result<(HeartbeatSender, HeartbeatStream, HeartbeatConfig)>

Returns a heartbeat bidirectional streaming: (sender, receiver), the other end is the leader of metasrv.

The datanode needs to use the sender to continuously send heartbeat packets (some self-state data), and the receiver can receive a response from “metasrv” (which may contain some scheduling instructions).

Returns the heartbeat sender, stream, and configuration received from Metasrv.

pub async fn range(&self, req: RangeRequest) -> Result<RangeResponse>

Range gets the keys in the range from the key-value store.

pub async fn put(&self, req: PutRequest) -> Result<PutResponse>

Put puts the given key into the key-value store.

pub async fn batch_get(&self, req: BatchGetRequest) -> Result<BatchGetResponse>

BatchGet atomically get values by the given keys from the key-value store.

pub async fn batch_put(&self, req: BatchPutRequest) -> Result<BatchPutResponse>

BatchPut atomically puts the given keys into the key-value store.

pub async fn batch_delete( &self, req: BatchDeleteRequest, ) -> Result<BatchDeleteResponse>

BatchDelete atomically deletes the given keys from the key-value store.

pub async fn compare_and_put( &self, req: CompareAndPutRequest, ) -> Result<CompareAndPutResponse>

CompareAndPut atomically puts the value to the given updated value if the current value == the expected value.

pub async fn delete_range( &self, req: DeleteRangeRequest, ) -> Result<DeleteRangeResponse>

DeleteRange deletes the given range from the key-value store.

pub async fn query_procedure_state( &self, pid: &str, ) -> Result<ProcedureStateResponse>

Query the procedure state by its id.

pub async fn migrate_region( &self, request: MigrateRegionRequest, ) -> Result<MigrateRegionResponse>

Submit a region migration task.

pub async fn reconcile( &self, request: ReconcileRequest, ) -> Result<ReconcileResponse>

Reconcile the procedure state.

pub async fn gc_regions(&self, request: GcRegionsRequest) -> Result<GcResponse>

Manually trigger GC for specific regions.

pub async fn gc_table(&self, request: GcTableRequest) -> Result<GcResponse>

Manually trigger GC for a table (all its regions).

pub async fn submit_ddl_task( &self, req: SubmitDdlTaskRequest, ) -> Result<SubmitDdlTaskResponse>

Submit a DDL task

pub fn heartbeat_client(&self) -> Result<HeartbeatClient>

pub fn config_client(&self) -> Result<ConfigClient>

pub fn store_client(&self) -> Result<StoreClient>

pub fn procedure_client(&self) -> Result<ProcedureClient>

pub fn cluster_client(&self) -> Result<ClusterClient>

pub fn channel_config(&self) -> &ChannelConfig

pub fn id(&self) -> Id

Trait Implementations

impl ClusterInfo for MetaClient

type Error = Error

fn list_nodes<'life0, 'async_trait>( &'life0 self, role: Option<ClusterRole>, ) -> Pin<Box<dyn Future<Output = Result<Vec<NodeInfo>>> + Send + 'async_trait>>

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

List all nodes by role in the cluster. If role is None, list all nodes.

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

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

List all region stats in the cluster.

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

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

List all flow stats in the cluster.

impl Debug for MetaClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ProcedureExecutor for MetaClient

fn submit_ddl_task<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 ExecutorContext, request: SubmitDdlTaskRequest, ) -> Pin<Box<dyn Future<Output = MetaResult<SubmitDdlTaskResponse>> + Send + 'async_trait>>

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

Submit a ddl task

fn migrate_region<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 ExecutorContext, request: MigrateRegionRequest, ) -> Pin<Box<dyn Future<Output = MetaResult<MigrateRegionResponse>> + Send + 'async_trait>>

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

Submit a region migration task

fn reconcile<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 ExecutorContext, request: ReconcileRequest, ) -> Pin<Box<dyn Future<Output = MetaResult<ReconcileResponse>> + Send + 'async_trait>>

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

Submit a reconcile task.

fn manage_region_follower<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 ExecutorContext, request: ManageRegionFollowerRequest, ) -> Pin<Box<dyn Future<Output = MetaResult<()>> + Send + 'async_trait>>

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

Submit ad manage region follower task

fn query_procedure_state<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 ExecutorContext, pid: &'life2 str, ) -> Pin<Box<dyn Future<Output = MetaResult<ProcedureStateResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Query the procedure state by its id

fn gc_regions<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 ExecutorContext, request: GcRegionsRequest, ) -> Pin<Box<dyn Future<Output = MetaResult<GcResponse>> + Send + 'async_trait>>

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

Manually trigger GC for the specified regions.

fn gc_table<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 ExecutorContext, request: GcTableRequest, ) -> Pin<Box<dyn Future<Output = MetaResult<GcResponse>> + Send + 'async_trait>>

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

Manually trigger GC for the specified table.

fn list_procedures<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 ExecutorContext, ) -> Pin<Box<dyn Future<Output = MetaResult<ProcedureDetailResponse>> + Send + 'async_trait>>

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