org.tikv.kvproto

Class DebugGrpc.DebugStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<DebugGrpc.DebugStub>

org.tikv.kvproto.DebugGrpc.DebugStub

Enclosing class:

DebugGrpc

public static final class DebugGrpc.DebugStub
extends io.grpc.stub.AbstractAsyncStub<DebugGrpc.DebugStub>

A stub to allow clients to do asynchronous 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.DebugStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	checkRegionConsistency(Debugpb.RegionConsistencyCheckRequest request, io.grpc.stub.StreamObserver<Debugpb.RegionConsistencyCheckResponse> responseObserver) Do a consistent check for a region.
void	compact(Debugpb.CompactRequest request, io.grpc.stub.StreamObserver<Debugpb.CompactResponse> responseObserver) Compact a column family in a specified range.
void	get(Debugpb.GetRequest request, io.grpc.stub.StreamObserver<Debugpb.GetResponse> responseObserver) Read a value arbitrarily for a key.
void	getAllRegionsInStore(Debugpb.GetAllRegionsInStoreRequest request, io.grpc.stub.StreamObserver<Debugpb.GetAllRegionsInStoreResponse> responseObserver) Get all region IDs in the store
void	getClusterInfo(Debugpb.GetClusterInfoRequest request, io.grpc.stub.StreamObserver<Debugpb.GetClusterInfoResponse> responseObserver) Get cluster ID
void	getMetrics(Debugpb.GetMetricsRequest request, io.grpc.stub.StreamObserver<Debugpb.GetMetricsResponse> responseObserver) Get Metrics
void	getRegionProperties(Debugpb.GetRegionPropertiesRequest request, io.grpc.stub.StreamObserver<Debugpb.GetRegionPropertiesResponse> responseObserver) Get region properties
void	getStoreInfo(Debugpb.GetStoreInfoRequest request, io.grpc.stub.StreamObserver<Debugpb.GetStoreInfoResponse> responseObserver) Get store ID
void	injectFailPoint(Debugpb.InjectFailPointRequest request, io.grpc.stub.StreamObserver<Debugpb.InjectFailPointResponse> responseObserver) Inject a fail point.
void	listFailPoints(Debugpb.ListFailPointsRequest request, io.grpc.stub.StreamObserver<Debugpb.ListFailPointsResponse> responseObserver) List all fail points.
void	modifyTikvConfig(Debugpb.ModifyTikvConfigRequest request, io.grpc.stub.StreamObserver<Debugpb.ModifyTikvConfigResponse> responseObserver) dynamically modify tikv's config
void	raftLog(Debugpb.RaftLogRequest request, io.grpc.stub.StreamObserver<Debugpb.RaftLogResponse> responseObserver) Read raft info.
void	recoverFailPoint(Debugpb.RecoverFailPointRequest request, io.grpc.stub.StreamObserver<Debugpb.RecoverFailPointResponse> responseObserver) Recover from a fail point.
void	regionInfo(Debugpb.RegionInfoRequest request, io.grpc.stub.StreamObserver<Debugpb.RegionInfoResponse> responseObserver)
void	regionSize(Debugpb.RegionSizeRequest request, io.grpc.stub.StreamObserver<Debugpb.RegionSizeResponse> responseObserver) Calculate size of a region.
void	resetToVersion(Debugpb.ResetToVersionRequest request, io.grpc.stub.StreamObserver<Debugpb.ResetToVersionResponse> responseObserver) Make this TiKV node return to the status on this node to certain ts.
void	scanMvcc(Debugpb.ScanMvccRequest request, io.grpc.stub.StreamObserver<Debugpb.ScanMvccResponse> responseObserver) Scan a specific range.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

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.DebugStub build(io.grpc.Channel channel,
                                    io.grpc.CallOptions callOptions)

Specified by:

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

get

public void get(Debugpb.GetRequest request,
                io.grpc.stub.StreamObserver<Debugpb.GetResponse> responseObserver)

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

raftLog

public void raftLog(Debugpb.RaftLogRequest request,
                    io.grpc.stub.StreamObserver<Debugpb.RaftLogResponse> responseObserver)

 Read raft info.
 

regionInfo

public void regionInfo(Debugpb.RegionInfoRequest request,
                       io.grpc.stub.StreamObserver<Debugpb.RegionInfoResponse> responseObserver)

regionSize

public void regionSize(Debugpb.RegionSizeRequest request,
                       io.grpc.stub.StreamObserver<Debugpb.RegionSizeResponse> responseObserver)

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

scanMvcc

public void scanMvcc(Debugpb.ScanMvccRequest request,
                     io.grpc.stub.StreamObserver<Debugpb.ScanMvccResponse> responseObserver)

 Scan a specific range.
 Note: DO NOT CALL IT IN PRODUCTION, it's really expensive.
       Server uses keys directly w/o any encoding.
 

compact

public void compact(Debugpb.CompactRequest request,
                    io.grpc.stub.StreamObserver<Debugpb.CompactResponse> responseObserver)

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

injectFailPoint

public void injectFailPoint(Debugpb.InjectFailPointRequest request,
                            io.grpc.stub.StreamObserver<Debugpb.InjectFailPointResponse> responseObserver)

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

recoverFailPoint

public void recoverFailPoint(Debugpb.RecoverFailPointRequest request,
                             io.grpc.stub.StreamObserver<Debugpb.RecoverFailPointResponse> responseObserver)

 Recover from a fail point.
 

listFailPoints

public void listFailPoints(Debugpb.ListFailPointsRequest request,
                           io.grpc.stub.StreamObserver<Debugpb.ListFailPointsResponse> responseObserver)

 List all fail points.
 

getMetrics

public void getMetrics(Debugpb.GetMetricsRequest request,
                       io.grpc.stub.StreamObserver<Debugpb.GetMetricsResponse> responseObserver)

 Get Metrics
 

checkRegionConsistency

public void checkRegionConsistency(Debugpb.RegionConsistencyCheckRequest request,
                                   io.grpc.stub.StreamObserver<Debugpb.RegionConsistencyCheckResponse> responseObserver)

 Do a consistent check for a region.
 

modifyTikvConfig

public void modifyTikvConfig(Debugpb.ModifyTikvConfigRequest request,
                             io.grpc.stub.StreamObserver<Debugpb.ModifyTikvConfigResponse> responseObserver)

 dynamically modify tikv's config
 

getRegionProperties

public void getRegionProperties(Debugpb.GetRegionPropertiesRequest request,
                                io.grpc.stub.StreamObserver<Debugpb.GetRegionPropertiesResponse> responseObserver)

 Get region properties
 

getStoreInfo

public void getStoreInfo(Debugpb.GetStoreInfoRequest request,
                         io.grpc.stub.StreamObserver<Debugpb.GetStoreInfoResponse> responseObserver)

 Get store ID
 

getClusterInfo

public void getClusterInfo(Debugpb.GetClusterInfoRequest request,
                           io.grpc.stub.StreamObserver<Debugpb.GetClusterInfoResponse> responseObserver)

 Get cluster ID
 

getAllRegionsInStore

public void getAllRegionsInStore(Debugpb.GetAllRegionsInStoreRequest request,
                                 io.grpc.stub.StreamObserver<Debugpb.GetAllRegionsInStoreResponse> responseObserver)

 Get all region IDs in the store
 

resetToVersion

public void resetToVersion(Debugpb.ResetToVersionRequest request,
                           io.grpc.stub.StreamObserver<Debugpb.ResetToVersionResponse> responseObserver)

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