PDClient (TiSpark Project TiKV Java Client 3.1.1 API)

java.lang.Object
- com.pingcap.tikv.AbstractGRPCClient<PDGrpc.PDBlockingStub,PDGrpc.PDStub>
- - com.pingcap.tikv.PDClient

所有已实现的接口:: ReadOnlyPDClient, AutoCloseable

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

字段概要
- 从类继承的字段 com.pingcap.tikv.AbstractGRPCClient
  asyncStub, blockingStub, channelFactory, conf, timeout

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`close()`
`static ReadOnlyPDClient`	`create(TiConfiguration conf, ChannelFactory channelFactory)`
`List<Metapb.Store>`	`getAllStores(BackOffer backOffer)`
`protected PDGrpc.PDStub`	`getAsyncStub()`
`protected PDGrpc.PDBlockingStub`	`getBlockingStub()`
`HostMapping`	`getHostMapping()`
`TiRegion`	`getRegionByID(BackOffer backOffer, long id)` Get Region by Region Id
`Future<TiRegion>`	`getRegionByIDAsync(BackOffer backOffer, long id)`
`TiRegion`	`getRegionByKey(BackOffer backOffer, com.google.protobuf.ByteString key)` Get Region from PD by key specified
`Future<TiRegion>`	`getRegionByKeyAsync(BackOffer backOffer, com.google.protobuf.ByteString key)`
`Metapb.Store`	`getStore(BackOffer backOffer, long storeId)` Get Store by StoreId
`Future<Metapb.Store>`	`getStoreAsync(BackOffer backOffer, long storeId)`
`double`	`getTiFlashReplicaProgress(long tableId)`
`TiTimestamp`	`getTimestamp(BackOffer backOffer)` Get Timestamp from Placement Driver
`void`	`updateLeader()`
`void`	`updateLeaderOrForwardFollower()`
`void`	`updateTiFlashReplicaStatus()`

从类继承的方法 com.pingcap.tikv.AbstractGRPCClient
callAsyncWithRetry, callServerStreamingWithRetry, callWithRetry, checkHealth, getConf, getTimeout

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - create
```
public static ReadOnlyPDClient create(TiConfiguration conf,
                                      ChannelFactory channelFactory)
```
  - getTimestamp
```
public TiTimestamp getTimestamp(BackOffer backOffer)
```
    从接口复制的说明: ReadOnlyPDClient
    
    Get Timestamp from Placement Driver
    
    指定者:
    
    getTimestamp 在接口中 ReadOnlyPDClient
    
    返回:
    
    a timestamp object
  - getHostMapping
```
public HostMapping getHostMapping()
```
    指定者:
    
    getHostMapping 在接口中 ReadOnlyPDClient
  - getRegionByKey
```
public TiRegion getRegionByKey(BackOffer backOffer,
                               com.google.protobuf.ByteString key)
```
    从接口复制的说明: ReadOnlyPDClient
    
    Get Region from PD by key specified
    
    指定者:
    
    getRegionByKey 在接口中 ReadOnlyPDClient
    
    key - key in bytes for locating a region
    
    返回:
    
    the region whose startKey and endKey range covers the given key
  - getRegionByKeyAsync
```
public Future<TiRegion> getRegionByKeyAsync(BackOffer backOffer,
                                            com.google.protobuf.ByteString key)
```
    指定者:
    
    getRegionByKeyAsync 在接口中 ReadOnlyPDClient
  - getRegionByID
```
public TiRegion getRegionByID(BackOffer backOffer,
                              long id)
```
    从接口复制的说明: ReadOnlyPDClient
    
    Get Region by Region Id
    
    指定者:
    
    getRegionByID 在接口中 ReadOnlyPDClient
    
    id - Region Id
    
    返回:
    
    the region corresponding to the given Id
  - getRegionByIDAsync
```
public Future<TiRegion> getRegionByIDAsync(BackOffer backOffer,
                                           long id)
```
    指定者:
    
    getRegionByIDAsync 在接口中 ReadOnlyPDClient
  - getStore
```
public Metapb.Store getStore(BackOffer backOffer,
                             long storeId)
```
    从接口复制的说明: ReadOnlyPDClient
    
    Get Store by StoreId
    
    指定者:
    
    getStore 在接口中 ReadOnlyPDClient
    
    storeId - StoreId
    
    返回:
    
    the Store corresponding to the given Id
  - getStoreAsync
```
public Future<Metapb.Store> getStoreAsync(BackOffer backOffer,
                                          long storeId)
```
    指定者:
    
    getStoreAsync 在接口中 ReadOnlyPDClient
  - getAllStores
```
public List<Metapb.Store> getAllStores(BackOffer backOffer)
```
    指定者:
    
    getAllStores 在接口中 ReadOnlyPDClient
  - close
```
public void close()
           throws InterruptedException
```
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    InterruptedException
  - updateLeader
```
public void updateLeader()
```
  - updateLeaderOrForwardFollower
```
public void updateLeaderOrForwardFollower()
```
  - updateTiFlashReplicaStatus
```
public void updateTiFlashReplicaStatus()
```
  - getTiFlashReplicaProgress
```
public double getTiFlashReplicaProgress(long tableId)
```
  - getBlockingStub
```
protected PDGrpc.PDBlockingStub getBlockingStub()
```
    指定者:
    
    getBlockingStub 在类中 AbstractGRPCClient<PDGrpc.PDBlockingStub,PDGrpc.PDStub>
  - getAsyncStub
```
protected PDGrpc.PDStub getAsyncStub()
```
    指定者:
    
    getAsyncStub 在类中 AbstractGRPCClient<PDGrpc.PDBlockingStub,PDGrpc.PDStub>

类 PDClient

字段概要

从类继承的字段 com.pingcap.tikv.AbstractGRPCClient

方法概要

从类继承的方法 com.pingcap.tikv.AbstractGRPCClient

从类继承的方法 java.lang.Object

方法详细资料

create

getTimestamp

getHostMapping

getRegionByKey

getRegionByKeyAsync

getRegionByID

getRegionByIDAsync

getStore

getStoreAsync

getAllStores

close

updateLeader

updateLeaderOrForwardFollower

updateTiFlashReplicaStatus

getTiFlashReplicaProgress

getBlockingStub

getAsyncStub