org.tikv.common

Class PDClient

java.lang.Object

org.tikv.common.AbstractGRPCClient<PDGrpc.PDBlockingStub,PDGrpc.PDFutureStub>

org.tikv.common.PDClient

All Implemented Interfaces:

AutoCloseable, ReadOnlyPDClient

public class PDClient
extends AbstractGRPCClient<PDGrpc.PDBlockingStub,PDGrpc.PDFutureStub>
implements ReadOnlyPDClient

Field Summary

Fields

Modifier and Type	Field and Description
static io.prometheus.client.Histogram	PD_GET_REGION_BY_KEY_REQUEST_LATENCY

Fields inherited from class org.tikv.common.AbstractGRPCClient

asyncStub, blockingStub, channelFactory, conf, timeout

Method Summary

Modifier and Type	Method and Description
void	close()
static ReadOnlyPDClient	create(TiConfiguration conf, RequestKeyCodec codec, ChannelFactory channelFactory)
List<Metapb.Store>	getAllStores(BackOffer backOffer)
protected PDGrpc.PDFutureStub	getAsyncStub()
protected PDGrpc.PDBlockingStub	getBlockingStub()
Long	getClusterId()
RequestKeyCodec	getCodec()
HostMapping	getHostMapping()
List<URI>	getPdAddrs()
Pair<Metapb.Region,Metapb.Peer>	getRegionByID(BackOffer backOffer, long id) Get Region by Region Id
Pair<Metapb.Region,Metapb.Peer>	getRegionByKey(BackOffer backOffer, com.google.protobuf.ByteString key) Get Region from PD by key specified
TiConfiguration.ReplicaRead	getReplicaRead()
Metapb.Store	getStore(BackOffer backOffer, long storeId) Get Store by StoreId
double	getTiFlashReplicaProgress(long tableId)
TiTimestamp	getTimestamp(BackOffer backOffer) Get Timestamp from Placement Driver
Boolean	isCheckerPaused(PDChecker checker)
void	keepPauseChecker(PDChecker checker)
void	resumeChecker(PDChecker checker)
List<Pdpb.Region>	scanRegions(BackOffer backOffer, com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, int limit)
void	stopKeepPauseChecker(PDChecker checker)
void	tryUpdateLeader()
void	tryUpdateLeaderOrForwardFollower()
Long	updateServiceGCSafePoint(String serviceId, long ttl, long safePoint, BackOffer backOffer) Update ServiceGCSafePoint
void	updateTiFlashReplicaStatus()

Methods inherited from class org.tikv.common.AbstractGRPCClient

callAsyncWithRetry, callServerStreamingWithRetry, callWithRetry, checkHealth, getConf, getTimeout, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

PD_GET_REGION_BY_KEY_REQUEST_LATENCY

public static final io.prometheus.client.Histogram PD_GET_REGION_BY_KEY_REQUEST_LATENCY

Method Detail

create

public static ReadOnlyPDClient create(TiConfiguration conf,
                                      RequestKeyCodec codec,
                                      ChannelFactory channelFactory)

getHostMapping

public HostMapping getHostMapping()

Specified by:

getHostMapping in interface ReadOnlyPDClient

getTimestamp

public TiTimestamp getTimestamp(BackOffer backOffer)

Description copied from interface: ReadOnlyPDClient

Get Timestamp from Placement Driver

Specified by:

getTimestamp in interface ReadOnlyPDClient

Returns:

a timestamp object

keepPauseChecker

public void keepPauseChecker(PDChecker checker)

stopKeepPauseChecker

public void stopKeepPauseChecker(PDChecker checker)

resumeChecker

public void resumeChecker(PDChecker checker)

isCheckerPaused

public Boolean isCheckerPaused(PDChecker checker)

getRegionByKey

public Pair<Metapb.Region,Metapb.Peer> getRegionByKey(BackOffer backOffer,
                                                      com.google.protobuf.ByteString key)

Description copied from interface: ReadOnlyPDClient

Get Region from PD by key specified

Specified by:

getRegionByKey in interface ReadOnlyPDClient

key - key in bytes for locating a region

Returns:

the region whose startKey and endKey range covers the given key

getRegionByID

public Pair<Metapb.Region,Metapb.Peer> getRegionByID(BackOffer backOffer,
                                                     long id)

Description copied from interface: ReadOnlyPDClient

Get Region by Region Id

Specified by:

getRegionByID in interface ReadOnlyPDClient

id - Region Id

Returns:

the region corresponding to the given Id

scanRegions

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

Specified by:

scanRegions in interface ReadOnlyPDClient

getStore

public Metapb.Store getStore(BackOffer backOffer,
                             long storeId)

Description copied from interface: ReadOnlyPDClient

Get Store by StoreId

Specified by:

getStore in interface ReadOnlyPDClient

storeId - StoreId

Returns:

the Store corresponding to the given Id

getAllStores

public List<Metapb.Store> getAllStores(BackOffer backOffer)

Specified by:

getAllStores in interface ReadOnlyPDClient

getReplicaRead

public TiConfiguration.ReplicaRead getReplicaRead()

Specified by:

getReplicaRead in interface ReadOnlyPDClient

updateServiceGCSafePoint

public Long updateServiceGCSafePoint(String serviceId,
                                     long ttl,
                                     long safePoint,
                                     BackOffer backOffer)

Description copied from interface: ReadOnlyPDClient

Update ServiceGCSafePoint

Specified by:

updateServiceGCSafePoint in interface ReadOnlyPDClient

Parameters:

serviceId - ServiceId

ttl - TTL in seconds

safePoint - The TiTimestamp you want to set. Set to start_ts.getPrevious() is a good practice

Returns:

the MinSafePoint of all services. If this value is greater than safePoint, it means update failed

close

public void close()
           throws InterruptedException

Specified by:

close in interface AutoCloseable

Throws:

InterruptedException

tryUpdateLeaderOrForwardFollower

public void tryUpdateLeaderOrForwardFollower()

tryUpdateLeader

public void tryUpdateLeader()

updateTiFlashReplicaStatus

public void updateTiFlashReplicaStatus()

getTiFlashReplicaProgress

public double getTiFlashReplicaProgress(long tableId)

getBlockingStub

protected PDGrpc.PDBlockingStub getBlockingStub()

Specified by:

getBlockingStub in class AbstractGRPCClient<PDGrpc.PDBlockingStub,PDGrpc.PDFutureStub>

getAsyncStub

protected PDGrpc.PDFutureStub getAsyncStub()

Specified by:

getAsyncStub in class AbstractGRPCClient<PDGrpc.PDBlockingStub,PDGrpc.PDFutureStub>

getClusterId

public Long getClusterId()

Specified by:

getClusterId in interface ReadOnlyPDClient

getPdAddrs

public List<URI> getPdAddrs()

getCodec

public RequestKeyCodec getCodec()

Specified by:

getCodec in interface ReadOnlyPDClient