Struct test_raftstore::TestPdClient

pub struct TestPdClient {
    cluster_id: u64,
    cluster: Arc<RwLock<Cluster>>,
    timer: Handle,
    is_incompatible: bool,
    tso: AtomicU64,
    trigger_tso_failure: AtomicBool,
    feature_gate: FeatureGate,
}

Fields

cluster_id: u64

cluster: Arc<RwLock<Cluster>>

timer: Handle

is_incompatible: bool

tso: AtomicU64

trigger_tso_failure: AtomicBool

feature_gate: FeatureGate

Implementations

impl TestPdClient

pub fn new(cluster_id: u64, is_incompatible: bool) -> TestPdClient

pub fn get_stores(&self) -> Result<Vec<Store>>

fn check_bootstrap(&self) -> Result<()>

fn is_regions_empty(&self) -> bool

fn schedule_operator(&self, region_id: u64, op: Operator)

pub fn get_region_epoch(&self, region_id: u64) -> RegionEpoch

pub fn get_regions_number(&self) -> usize

pub fn disable_default_operator(&self)

pub fn enable_default_operator(&self)

pub fn must_have_peer(&self, region_id: u64, peer: Peer)

pub fn must_none_peer(&self, region_id: u64, peer: Peer)

pub fn must_none_pending_peer(&self, peer: Peer)

pub fn must_finish_joint_confchange(
    &self,
    region_id: u64,
    add_peers: Vec<Peer>,
    remove_peers: Vec<Peer>
)

pub fn must_not_in_joint(&self, region_id: u64)

pub fn add_region(&self, region: &Region)

pub fn transfer_leader(&self, region_id: u64, peer: Peer)

pub fn add_peer(&self, region_id: u64, peer: Peer)

pub fn remove_peer(&self, region_id: u64, peer: Peer)

pub fn joint_confchange(
    &self,
    region_id: u64,
    changes: Vec<(ConfChangeType, Peer)>
) -> (Vec<Peer>, Vec<Peer>)

pub fn leave_joint(&self, region_id: u64)

pub fn is_in_joint(&self, region_id: u64) -> bool

pub fn split_region(
    &self,
    region: Region,
    policy: CheckPolicy,
    keys: Vec<Vec<u8>>
)

pub fn must_split_region(
    &self,
    region: Region,
    policy: CheckPolicy,
    keys: Vec<Vec<u8>>
)

pub fn must_add_peer(&self, region_id: u64, peer: Peer)

pub fn must_remove_peer(&self, region_id: u64, peer: Peer)

pub fn must_joint_confchange(
    &self,
    region_id: u64,
    changes: Vec<(ConfChangeType, Peer)>
)

pub fn must_leave_joint(&self, region_id: u64)

pub fn merge_region(&self, from: u64, target: u64)

pub fn must_merge(&self, from: u64, target: u64)

pub fn check_merged(&self, from: u64) -> bool

pub fn check_merged_timeout(&self, from: u64, duration: Duration)

pub fn region_leader_must_be(&self, region_id: u64, peer: Peer)

pub fn check_split(&self, region: &Region, split_key: &[u8]) -> bool

pub fn get_store_stats(&self, store_id: u64) -> Option<StoreStats>

pub fn get_split_count(&self) -> usize

pub fn get_down_peers(&self) -> HashMap<u64, PeerStats>

pub fn get_pending_peers(&self) -> HashMap<u64, Peer>

pub fn set_bootstrap(&self, is_bootstraped: bool)

pub fn configure_dr_auto_sync(&self, label_key: &str)

pub fn switch_replication_mode(&self, state: DrAutoSyncState)

pub fn region_replication_status(
    &self,
    region_id: u64
) -> RegionReplicationStatus

pub fn get_region_approximate_size(&self, region_id: u64) -> Option<u64>

pub fn get_region_approximate_keys(&self, region_id: u64) -> Option<u64>

pub fn get_region_last_report_ts(&self, region_id: u64) -> Option<UnixSecs>

pub fn get_region_last_report_term(&self, region_id: u64) -> Option<u64>

pub fn get_store_hotspots(
    &self,
    store_id: u64
) -> Option<HashMap<u64, PeerStat>>

pub fn set_gc_safe_point(&self, safe_point: u64)

pub fn trigger_tso_failure(&self)

pub fn shutdown_store(&self, store_id: u64)

pub fn ignore_merge_target_integrity(&self)

pub fn set_tso(&self, ts: TimeStamp)

pub fn reset_version(&self, version: &str)

Trait Implementations

impl PdClient for TestPdClient

fn get_cluster_id(&self) -> Result<u64>

Returns the cluster ID.

fn bootstrap_cluster(
    &self,
    store: Store,
    region: Region
) -> Result<Option<ReplicationStatus>>

Creates the cluster with cluster ID, node, stores and first Region. If the cluster is already bootstrapped, return ClusterBootstrapped error. When a node starts, if it finds nothing in the node and cluster is not bootstrapped, it begins to create node, stores, first Region and then call bootstrap_cluster to let PD know it. It may happen that multi nodes start at same time to try to bootstrap, but only one can succeed, while others will fail and must remove their created local Region data themselves.

fn is_cluster_bootstrapped(&self) -> Result<bool>

Returns whether the cluster is bootstrapped or not.

fn alloc_id(&self) -> Result<u64>

Allocates a unique positive id.

fn put_store(&self, store: Store) -> Result<Option<ReplicationStatus>>

Informs PD when the store starts or some store information changes.

fn get_all_stores(&self, _exclude_tombstone: bool) -> Result<Vec<Store>>

Gets all stores information.

fn get_store(&self, store_id: u64) -> Result<Store>

We don’t need to support Region and Peer put/delete, because PD knows all Region and Peers itself:

fn get_store_async(&self, store_id: u64) -> PdFuture<Store>

Gets store information if it is not a tombstone store asynchronously

fn get_region(&self, key: &[u8]) -> Result<Region>

For route. Gets Region which the key belongs to.

fn get_region_info(&self, key: &[u8]) -> Result<RegionInfo>

Gets Region info which the key belongs to.

fn get_region_by_id(&self, region_id: u64) -> PdFuture<Option<Region>>

Gets Region by Region id.

fn get_region_leader_by_id(
    &self,
    region_id: u64
) -> PdFuture<Option<(Region, Peer)>>

Gets Region and its leader by Region id.

fn get_cluster_config(&self) -> Result<Cluster>

Gets cluster meta information.

fn region_heartbeat(
    &self,
    term: u64,
    region: Region,
    leader: Peer,
    region_stat: RegionStat,
    replication_status: Option<RegionReplicationStatus>
) -> PdFuture<()>

Region’s Leader uses this to heartbeat PD.

fn handle_region_heartbeat_response<F>(
    &self,
    store_id: u64,
    f: F
) -> PdFuture<()> where
    Self: Sized,
    F: Fn(RegionHeartbeatResponse) + Send + 'static, 

Gets a stream of Region heartbeat response.

fn ask_split(&self, region: Region) -> PdFuture<AskSplitResponse>

Asks PD for split. PD returns the newly split Region id.

fn ask_batch_split(
    &self,
    region: Region,
    count: usize
) -> PdFuture<AskBatchSplitResponse>

Asks PD for batch split. PD returns the newly split Region ids.

fn store_heartbeat(&self, stats: StoreStats) -> PdFuture<StoreHeartbeatResponse>

Sends store statistics regularly.

fn report_batch_split(&self, regions: Vec<Region>) -> PdFuture<()>

Reports PD the split Region.

fn get_gc_safe_point(&self) -> PdFuture<u64>

fn get_store_stats_async(
    &self,
    store_id: u64
) -> BoxFuture<'_, Result<StoreStats>>

Gets store state if it is not a tombstone store asynchronously.

fn get_operator(&self, region_id: u64) -> Result<GetOperatorResponse>

Gets current operator of the region

fn get_tso(&self) -> PdFuture<TimeStamp>

Gets a timestamp from PD.

fn feature_gate(&self) -> &FeatureGate

Gets the internal FeatureGate.

pub fn get_region_async(
    &'k self,
    _key: &'k [u8]
) -> Pin<Box<dyn Future<Output = Result<Region, Error>> + 'k + Send, Global>>

Gets Region which the key belongs to asynchronously.

pub fn get_region_info_async(
    &'k self,
    _key: &'k [u8]
) -> Pin<Box<dyn Future<Output = Result<RegionInfo, Error>> + 'k + Send, Global>>

Gets Region info which the key belongs to asynchronously.

pub fn scatter_region(&self, RegionInfo) -> Result<(), Error>

Scatters the Region across the cluster.

pub fn handle_reconnect<F>(&self, F) where
    F: 'static + Fn() + Sync + Send, 

Registers a handler to the client, which will be invoked after reconnecting to PD.