org.tikv.common

Interface ReadOnlyPDClient

All Known Implementing Classes:

PDClient

public interface ReadOnlyPDClient

Readonly PD client including only reading related interface Supposed for TiDB-like use cases

Method Summary

Modifier and Type	Method and Description
List<Metapb.Store>	getAllStores(BackOffer backOffer)
Long	getClusterId()
RequestKeyCodec	getCodec()
HostMapping	getHostMapping()
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
TiTimestamp	getTimestamp(BackOffer backOffer) Get Timestamp from Placement Driver
List<Pdpb.Region>	scanRegions(BackOffer backOffer, com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, int limit)
Long	updateServiceGCSafePoint(String serviceId, long ttl, long safePoint, BackOffer backOffer) Update ServiceGCSafePoint

Method Detail

getTimestamp

TiTimestamp getTimestamp(BackOffer backOffer)

Get Timestamp from Placement Driver

Returns:

a timestamp object

getRegionByKey

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

Get Region from PD by key specified

Parameters:

key - key in bytes for locating a region

Returns:

the region whose startKey and endKey range covers the given key

getRegionByID

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

Get Region by Region Id

Parameters:

id - Region Id

Returns:

the region corresponding to the given Id

scanRegions

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

getHostMapping

HostMapping getHostMapping()

getStore

Metapb.Store getStore(BackOffer backOffer,
                      long storeId)

Get Store by StoreId

Parameters:

storeId - StoreId

Returns:

the Store corresponding to the given Id

getAllStores

List<Metapb.Store> getAllStores(BackOffer backOffer)

getReplicaRead

TiConfiguration.ReplicaRead getReplicaRead()

getClusterId

Long getClusterId()

getCodec

RequestKeyCodec getCodec()

updateServiceGCSafePoint

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

Update ServiceGCSafePoint

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