org.tikv.kvproto

Class DebugGrpc.DebugBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<DebugGrpc.DebugBlockingStub>

org.tikv.kvproto.DebugGrpc.DebugBlockingStub

Enclosing class:

DebugGrpc

public static final class DebugGrpc.DebugBlockingStub
extends io.grpc.stub.AbstractBlockingStub<DebugGrpc.DebugBlockingStub>

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

Methods inherited from class io.grpc.stub.AbstractBlockingStub

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

Specified by:

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

get

public Debugpb.GetResponse get(Debugpb.GetRequest request)

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

raftLog

public Debugpb.RaftLogResponse raftLog(Debugpb.RaftLogRequest request)

 Read raft info.
 

regionInfo

public Debugpb.RegionInfoResponse regionInfo(Debugpb.RegionInfoRequest request)

regionSize

public Debugpb.RegionSizeResponse regionSize(Debugpb.RegionSizeRequest request)

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

scanMvcc

public Iterator<Debugpb.ScanMvccResponse> scanMvcc(Debugpb.ScanMvccRequest request)

 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 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 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 Debugpb.RecoverFailPointResponse recoverFailPoint(Debugpb.RecoverFailPointRequest request)

 Recover from a fail point.
 

listFailPoints

public Debugpb.ListFailPointsResponse listFailPoints(Debugpb.ListFailPointsRequest request)

 List all fail points.
 

getMetrics

public Debugpb.GetMetricsResponse getMetrics(Debugpb.GetMetricsRequest request)

 Get Metrics
 

checkRegionConsistency

public Debugpb.RegionConsistencyCheckResponse checkRegionConsistency(Debugpb.RegionConsistencyCheckRequest request)

 Do a consistent check for a region.
 

modifyTikvConfig

public Debugpb.ModifyTikvConfigResponse modifyTikvConfig(Debugpb.ModifyTikvConfigRequest request)

 dynamically modify tikv's config
 

getRegionProperties

public Debugpb.GetRegionPropertiesResponse getRegionProperties(Debugpb.GetRegionPropertiesRequest request)

 Get region properties
 

getStoreInfo

public Debugpb.GetStoreInfoResponse getStoreInfo(Debugpb.GetStoreInfoRequest request)

 Get store ID
 

getClusterInfo

public Debugpb.GetClusterInfoResponse getClusterInfo(Debugpb.GetClusterInfoRequest request)

 Get cluster ID
 

getAllRegionsInStore

public Debugpb.GetAllRegionsInStoreResponse getAllRegionsInStore(Debugpb.GetAllRegionsInStoreRequest request)

 Get all region IDs in the store
 

resetToVersion

public Debugpb.ResetToVersionResponse resetToVersion(Debugpb.ResetToVersionRequest request)

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