org.tikv.kvproto

Class DebugGrpc.DebugFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<DebugGrpc.DebugFutureStub>

org.tikv.kvproto.DebugGrpc.DebugFutureStub

Enclosing class:

DebugGrpc

public static final class DebugGrpc.DebugFutureStub
extends io.grpc.stub.AbstractFutureStub<DebugGrpc.DebugFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Debug.

 Debug service for TiKV.
 Errors are defined as follow:
   - OK: Okay, we are good!
   - UNKNOWN: For unknown error.
   - INVALID_ARGUMENT: Something goes wrong within requests.
   - NOT_FOUND: It is key or region not found, it's based on context, detailed
                reason can be found in grpc message.
 Note: It bypasses raft layer.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected DebugGrpc.DebugFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Debugpb.RegionConsistencyCheckResponse>	checkRegionConsistency(Debugpb.RegionConsistencyCheckRequest request) Do a consistent check for a region.
com.google.common.util.concurrent.ListenableFuture<Debugpb.CompactResponse>	compact(Debugpb.CompactRequest request) Compact a column family in a specified range.
com.google.common.util.concurrent.ListenableFuture<Debugpb.GetResponse>	get(Debugpb.GetRequest request) Read a value arbitrarily for a key.
com.google.common.util.concurrent.ListenableFuture<Debugpb.GetAllRegionsInStoreResponse>	getAllRegionsInStore(Debugpb.GetAllRegionsInStoreRequest request) Get all region IDs in the store
com.google.common.util.concurrent.ListenableFuture<Debugpb.GetClusterInfoResponse>	getClusterInfo(Debugpb.GetClusterInfoRequest request) Get cluster ID
com.google.common.util.concurrent.ListenableFuture<Debugpb.GetMetricsResponse>	getMetrics(Debugpb.GetMetricsRequest request) Get Metrics
com.google.common.util.concurrent.ListenableFuture<Debugpb.GetRegionPropertiesResponse>	getRegionProperties(Debugpb.GetRegionPropertiesRequest request) Get region properties
com.google.common.util.concurrent.ListenableFuture<Debugpb.GetStoreInfoResponse>	getStoreInfo(Debugpb.GetStoreInfoRequest request) Get store ID
com.google.common.util.concurrent.ListenableFuture<Debugpb.InjectFailPointResponse>	injectFailPoint(Debugpb.InjectFailPointRequest request) Inject a fail point.
com.google.common.util.concurrent.ListenableFuture<Debugpb.ListFailPointsResponse>	listFailPoints(Debugpb.ListFailPointsRequest request) List all fail points.
com.google.common.util.concurrent.ListenableFuture<Debugpb.ModifyTikvConfigResponse>	modifyTikvConfig(Debugpb.ModifyTikvConfigRequest request) dynamically modify tikv's config
com.google.common.util.concurrent.ListenableFuture<Debugpb.RaftLogResponse>	raftLog(Debugpb.RaftLogRequest request) Read raft info.
com.google.common.util.concurrent.ListenableFuture<Debugpb.RecoverFailPointResponse>	recoverFailPoint(Debugpb.RecoverFailPointRequest request) Recover from a fail point.
com.google.common.util.concurrent.ListenableFuture<Debugpb.RegionInfoResponse>	regionInfo(Debugpb.RegionInfoRequest request)
com.google.common.util.concurrent.ListenableFuture<Debugpb.RegionSizeResponse>	regionSize(Debugpb.RegionSizeRequest request) Calculate size of a region.
com.google.common.util.concurrent.ListenableFuture<Debugpb.ResetToVersionResponse>	resetToVersion(Debugpb.ResetToVersionRequest request) Make this TiKV node return to the status on this node to certain ts.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected DebugGrpc.DebugFutureStub build(io.grpc.Channel channel,
                                          io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<DebugGrpc.DebugFutureStub>

get

public com.google.common.util.concurrent.ListenableFuture<Debugpb.GetResponse> get(Debugpb.GetRequest request)

 Read a value arbitrarily for a key.
 Note: Server uses key directly w/o any encoding.
 

raftLog

public com.google.common.util.concurrent.ListenableFuture<Debugpb.RaftLogResponse> raftLog(Debugpb.RaftLogRequest request)

 Read raft info.
 

regionInfo

public com.google.common.util.concurrent.ListenableFuture<Debugpb.RegionInfoResponse> regionInfo(Debugpb.RegionInfoRequest request)

regionSize

public com.google.common.util.concurrent.ListenableFuture<Debugpb.RegionSizeResponse> regionSize(Debugpb.RegionSizeRequest request)

 Calculate size of a region.
 Note: DO NOT CALL IT IN PRODUCTION, it's really expensive.
 

compact

public com.google.common.util.concurrent.ListenableFuture<Debugpb.CompactResponse> compact(Debugpb.CompactRequest request)

 Compact a column family in a specified range.
 Note: Server uses keys directly w/o any encoding.
 

injectFailPoint

public com.google.common.util.concurrent.ListenableFuture<Debugpb.InjectFailPointResponse> injectFailPoint(Debugpb.InjectFailPointRequest request)

 Inject a fail point. Currently, it's only used in tests.
 Note: DO NOT CALL IT IN PRODUCTION.
 

recoverFailPoint

public com.google.common.util.concurrent.ListenableFuture<Debugpb.RecoverFailPointResponse> recoverFailPoint(Debugpb.RecoverFailPointRequest request)

 Recover from a fail point.
 

listFailPoints

public com.google.common.util.concurrent.ListenableFuture<Debugpb.ListFailPointsResponse> listFailPoints(Debugpb.ListFailPointsRequest request)

 List all fail points.
 

getMetrics

public com.google.common.util.concurrent.ListenableFuture<Debugpb.GetMetricsResponse> getMetrics(Debugpb.GetMetricsRequest request)

 Get Metrics
 

checkRegionConsistency

public com.google.common.util.concurrent.ListenableFuture<Debugpb.RegionConsistencyCheckResponse> checkRegionConsistency(Debugpb.RegionConsistencyCheckRequest request)

 Do a consistent check for a region.
 

modifyTikvConfig

public com.google.common.util.concurrent.ListenableFuture<Debugpb.ModifyTikvConfigResponse> modifyTikvConfig(Debugpb.ModifyTikvConfigRequest request)

 dynamically modify tikv's config
 

getRegionProperties

public com.google.common.util.concurrent.ListenableFuture<Debugpb.GetRegionPropertiesResponse> getRegionProperties(Debugpb.GetRegionPropertiesRequest request)

 Get region properties
 

getStoreInfo

public com.google.common.util.concurrent.ListenableFuture<Debugpb.GetStoreInfoResponse> getStoreInfo(Debugpb.GetStoreInfoRequest request)

 Get store ID
 

getClusterInfo

public com.google.common.util.concurrent.ListenableFuture<Debugpb.GetClusterInfoResponse> getClusterInfo(Debugpb.GetClusterInfoRequest request)

 Get cluster ID
 

getAllRegionsInStore

public com.google.common.util.concurrent.ListenableFuture<Debugpb.GetAllRegionsInStoreResponse> getAllRegionsInStore(Debugpb.GetAllRegionsInStoreRequest request)

 Get all region IDs in the store
 

resetToVersion

public com.google.common.util.concurrent.ListenableFuture<Debugpb.ResetToVersionResponse> resetToVersion(Debugpb.ResetToVersionRequest request)

 Make this TiKV node return to the status on this node to certain ts.