org.tikv.common.region

Class RegionManager

java.lang.Object

org.tikv.common.region.RegionManager

public class RegionManager
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static io.prometheus.client.Histogram	GET_REGION_BY_KEY_REQUEST_LATENCY
static io.prometheus.client.Histogram	SCAN_REGIONS_REQUEST_LATENCY

Constructor Summary

Constructors

Constructor and Description
RegionManager(TiConfiguration conf, ReadOnlyPDClient pdClient)
RegionManager(TiConfiguration conf, ReadOnlyPDClient pdClient, ChannelFactory channelFactory)
RegionManager(TiConfiguration conf, ReadOnlyPDClient pdClient, ChannelFactory channelFactory, int callBackExecutorThreadNum)
RegionManager(TiConfiguration conf, ReadOnlyPDClient pdClient, int callBackExecutorThreadNum)

Method Summary

Modifier and Type	Method and Description
void	addCacheInvalidateCallback(Function<CacheInvalidateEvent,Void> cacheInvalidateCallback)
void	clearRegionCache() Clears all cache when some unexpected error occurs.
void	close()
TiRegion	createRegion(Metapb.Region region, BackOffer backOffer)
List<Function<CacheInvalidateEvent,Void>>	getCacheInvalidateCallbackList()
ExecutorService	getCallBackThreadPool()
ReadOnlyPDClient	getPDClient()
TiRegion	getRegionById(long regionId) Deprecated.
TiRegion	getRegionByKey(com.google.protobuf.ByteString key)
TiRegion	getRegionByKey(com.google.protobuf.ByteString key, BackOffer backOffer)
Pair<TiRegion,TiStore>	getRegionStorePairByKey(com.google.protobuf.ByteString key)
Pair<TiRegion,TiStore>	getRegionStorePairByKey(com.google.protobuf.ByteString key, BackOffer backOffer)
Pair<TiRegion,TiStore>	getRegionStorePairByKey(com.google.protobuf.ByteString key, TiStoreType storeType)
Pair<TiRegion,TiStore>	getRegionStorePairByKey(com.google.protobuf.ByteString key, TiStoreType storeType, BackOffer backOffer)
TiStore	getStoreById(long id)
TiStore	getStoreById(long id, BackOffer backOffer)
void	insertRegionToCache(TiRegion region)
void	invalidateAll()
void	invalidateRegion(TiRegion region)
void	invalidateStore(long storeId)
void	onRegionStale(TiRegion region)
void	onRequestFail(TiRegion region) Clears all cache when a TiKV server does not respond
List<Pdpb.Region>	scanRegions(BackOffer backOffer, com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, int limit)
TiRegion	updateLeader(TiRegion region, long storeId)
void	updateStore(TiStore oldStore, TiStore newStore)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GET_REGION_BY_KEY_REQUEST_LATENCY

public static final io.prometheus.client.Histogram GET_REGION_BY_KEY_REQUEST_LATENCY

SCAN_REGIONS_REQUEST_LATENCY

public static final io.prometheus.client.Histogram SCAN_REGIONS_REQUEST_LATENCY

Constructor Detail

RegionManager

public RegionManager(TiConfiguration conf,
                     ReadOnlyPDClient pdClient,
                     ChannelFactory channelFactory)

RegionManager

public RegionManager(TiConfiguration conf,
                     ReadOnlyPDClient pdClient)

RegionManager

public RegionManager(TiConfiguration conf,
                     ReadOnlyPDClient pdClient,
                     int callBackExecutorThreadNum)

RegionManager

public RegionManager(TiConfiguration conf,
                     ReadOnlyPDClient pdClient,
                     ChannelFactory channelFactory,
                     int callBackExecutorThreadNum)

Method Detail

close

public void close()

getPDClient

public ReadOnlyPDClient getPDClient()

getCallBackThreadPool

public ExecutorService getCallBackThreadPool()

getCacheInvalidateCallbackList

public List<Function<CacheInvalidateEvent,Void>> getCacheInvalidateCallbackList()

addCacheInvalidateCallback

public void addCacheInvalidateCallback(Function<CacheInvalidateEvent,Void> cacheInvalidateCallback)

invalidateAll

public void invalidateAll()

scanRegions

public List<Pdpb.Region> scanRegions(BackOffer backOffer,
                                     com.google.protobuf.ByteString startKey,
                                     com.google.protobuf.ByteString endKey,
                                     int limit)

getRegionByKey

public TiRegion getRegionByKey(com.google.protobuf.ByteString key)

getRegionByKey

public TiRegion getRegionByKey(com.google.protobuf.ByteString key,
                               BackOffer backOffer)

getRegionById

@Deprecated
public TiRegion getRegionById(long regionId)

Deprecated.

getRegionStorePairByKey

public Pair<TiRegion,TiStore> getRegionStorePairByKey(com.google.protobuf.ByteString key,
                                                      BackOffer backOffer)

getRegionStorePairByKey

public Pair<TiRegion,TiStore> getRegionStorePairByKey(com.google.protobuf.ByteString key)

getRegionStorePairByKey

public Pair<TiRegion,TiStore> getRegionStorePairByKey(com.google.protobuf.ByteString key,
                                                      TiStoreType storeType)

getRegionStorePairByKey

public Pair<TiRegion,TiStore> getRegionStorePairByKey(com.google.protobuf.ByteString key,
                                                      TiStoreType storeType,
                                                      BackOffer backOffer)

createRegion

public TiRegion createRegion(Metapb.Region region,
                             BackOffer backOffer)

getStoreById

public TiStore getStoreById(long id)

getStoreById

public TiStore getStoreById(long id,
                            BackOffer backOffer)

onRegionStale

public void onRegionStale(TiRegion region)

updateLeader

public TiRegion updateLeader(TiRegion region,
                             long storeId)

updateStore

public void updateStore(TiStore oldStore,
                        TiStore newStore)

clearRegionCache

public void clearRegionCache()

Clears all cache when some unexpected error occurs.

onRequestFail

public void onRequestFail(TiRegion region)

Clears all cache when a TiKV server does not respond

Parameters:

region - region

invalidateStore

public void invalidateStore(long storeId)

invalidateRegion

public void invalidateRegion(TiRegion region)

insertRegionToCache

public void insertRegionToCache(TiRegion region)