org.tikv.kvproto

Interface DebugGrpc.AsyncService

All Known Implementing Classes:

DebugGrpc.DebugImplBase

Enclosing class:

DebugGrpc

public static interface DebugGrpc.AsyncService

 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.
 

Method Summary

Modifier and Type	Method and Description
default void	checkRegionConsistency(Debugpb.RegionConsistencyCheckRequest request, io.grpc.stub.StreamObserver<Debugpb.RegionConsistencyCheckResponse> responseObserver) Do a consistent check for a region.
default void	compact(Debugpb.CompactRequest request, io.grpc.stub.StreamObserver<Debugpb.CompactResponse> responseObserver) Compact a column family in a specified range.
default void	get(Debugpb.GetRequest request, io.grpc.stub.StreamObserver<Debugpb.GetResponse> responseObserver) Read a value arbitrarily for a key.
default void	getAllRegionsInStore(Debugpb.GetAllRegionsInStoreRequest request, io.grpc.stub.StreamObserver<Debugpb.GetAllRegionsInStoreResponse> responseObserver) Get all region IDs in the store
default void	getClusterInfo(Debugpb.GetClusterInfoRequest request, io.grpc.stub.StreamObserver<Debugpb.GetClusterInfoResponse> responseObserver) Get cluster ID
default void	getMetrics(Debugpb.GetMetricsRequest request, io.grpc.stub.StreamObserver<Debugpb.GetMetricsResponse> responseObserver) Get Metrics
default void	getRegionProperties(Debugpb.GetRegionPropertiesRequest request, io.grpc.stub.StreamObserver<Debugpb.GetRegionPropertiesResponse> responseObserver) Get region properties
default void	getStoreInfo(Debugpb.GetStoreInfoRequest request, io.grpc.stub.StreamObserver<Debugpb.GetStoreInfoResponse> responseObserver) Get store ID
default void	injectFailPoint(Debugpb.InjectFailPointRequest request, io.grpc.stub.StreamObserver<Debugpb.InjectFailPointResponse> responseObserver) Inject a fail point.
default void	listFailPoints(Debugpb.ListFailPointsRequest request, io.grpc.stub.StreamObserver<Debugpb.ListFailPointsResponse> responseObserver) List all fail points.
default void	modifyTikvConfig(Debugpb.ModifyTikvConfigRequest request, io.grpc.stub.StreamObserver<Debugpb.ModifyTikvConfigResponse> responseObserver) dynamically modify tikv's config
default void	raftLog(Debugpb.RaftLogRequest request, io.grpc.stub.StreamObserver<Debugpb.RaftLogResponse> responseObserver) Read raft info.
default void	recoverFailPoint(Debugpb.RecoverFailPointRequest request, io.grpc.stub.StreamObserver<Debugpb.RecoverFailPointResponse> responseObserver) Recover from a fail point.
default void	regionInfo(Debugpb.RegionInfoRequest request, io.grpc.stub.StreamObserver<Debugpb.RegionInfoResponse> responseObserver)
default void	regionSize(Debugpb.RegionSizeRequest request, io.grpc.stub.StreamObserver<Debugpb.RegionSizeResponse> responseObserver) Calculate size of a region.
default 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.
default void	scanMvcc(Debugpb.ScanMvccRequest request, io.grpc.stub.StreamObserver<Debugpb.ScanMvccResponse> responseObserver) Scan a specific range.

Method Detail

get

default 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

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

 Read raft info.
 

regionInfo

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

regionSize

default 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

default 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

default 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

default 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

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

 Recover from a fail point.
 

listFailPoints

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

 List all fail points.
 

getMetrics

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

 Get Metrics
 

checkRegionConsistency

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

 Do a consistent check for a region.
 

modifyTikvConfig

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

 dynamically modify tikv's config
 

getRegionProperties

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

 Get region properties
 

getStoreInfo

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

 Get store ID
 

getClusterInfo

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

 Get cluster ID
 

getAllRegionsInStore

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

 Get all region IDs in the store
 

resetToVersion

default 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.