org.tikv.kvproto

Class TikvGrpc.TikvStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<TikvGrpc.TikvStub>

org.tikv.kvproto.TikvGrpc.TikvStub

Enclosing class:

TikvGrpc

public static final class TikvGrpc.TikvStub
extends io.grpc.stub.AbstractAsyncStub<TikvGrpc.TikvStub>

A stub to allow clients to do asynchronous rpc calls to service Tikv.

 Key/value store API for TiKV.
 

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
io.grpc.stub.StreamObserver<Tikvpb.BatchCommandsRequest>	batchCommands(io.grpc.stub.StreamObserver<Tikvpb.BatchCommandsResponse> responseObserver) Batched commands.
void	batchCoprocessor(Coprocessor.BatchRequest request, io.grpc.stub.StreamObserver<Coprocessor.BatchResponse> responseObserver)
io.grpc.stub.StreamObserver<Tikvpb.BatchRaftMessage>	batchRaft(io.grpc.stub.StreamObserver<RaftServerpb.Done> responseObserver)
protected TikvGrpc.TikvStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	cancelMPPTask(Mpp.CancelTaskRequest request, io.grpc.stub.StreamObserver<Mpp.CancelTaskResponse> responseObserver)
void	checkLeader(Kvrpcpb.CheckLeaderRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.CheckLeaderResponse> responseObserver) / CheckLeader sends all information (includes region term and epoch) to other stores.
void	checkLockObserver(Kvrpcpb.CheckLockObserverRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.CheckLockObserverResponse> responseObserver)
void	coprocessor(Coprocessor.Request request, io.grpc.stub.StreamObserver<Coprocessor.Response> responseObserver) Commands for executing SQL in the TiKV coprocessor (i.e., 'pushed down' to TiKV rather than executed in TiDB).
void	coprocessorStream(Coprocessor.Request request, io.grpc.stub.StreamObserver<Coprocessor.Response> responseObserver)
void	dispatchMPPTask(Mpp.DispatchTaskRequest request, io.grpc.stub.StreamObserver<Mpp.DispatchTaskResponse> responseObserver) These are for mpp execution.
void	establishMPPConnection(Mpp.EstablishMPPConnectionRequest request, io.grpc.stub.StreamObserver<Mpp.MPPDataPacket> responseObserver)
void	getLockWaitInfo(Kvrpcpb.GetLockWaitInfoRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.GetLockWaitInfoResponse> responseObserver) / Get the information about lock waiting from TiKV.
void	getStoreSafeTS(Kvrpcpb.StoreSafeTSRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.StoreSafeTSResponse> responseObserver) / Get the minimal `safe_ts` from regions at the store
void	isAlive(Mpp.IsAliveRequest request, io.grpc.stub.StreamObserver<Mpp.IsAliveResponse> responseObserver)
void	kvBatchGet(Kvrpcpb.BatchGetRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.BatchGetResponse> responseObserver)
void	kvBatchRollback(Kvrpcpb.BatchRollbackRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.BatchRollbackResponse> responseObserver)
void	kvCheckSecondaryLocks(Kvrpcpb.CheckSecondaryLocksRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.CheckSecondaryLocksResponse> responseObserver)
void	kvCheckTxnStatus(Kvrpcpb.CheckTxnStatusRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.CheckTxnStatusResponse> responseObserver)
void	kvCleanup(Kvrpcpb.CleanupRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.CleanupResponse> responseObserver)
void	kvCommit(Kvrpcpb.CommitRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.CommitResponse> responseObserver)
void	kvDeleteRange(Kvrpcpb.DeleteRangeRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.DeleteRangeResponse> responseObserver)
void	kvGC(Kvrpcpb.GCRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.GCResponse> responseObserver)
void	kvGet(Kvrpcpb.GetRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.GetResponse> responseObserver) Commands using a transactional interface.
void	kvImport(Kvrpcpb.ImportRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.ImportResponse> responseObserver)
void	kvPessimisticLock(Kvrpcpb.PessimisticLockRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.PessimisticLockResponse> responseObserver)
void	kVPessimisticRollback(Kvrpcpb.PessimisticRollbackRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.PessimisticRollbackResponse> responseObserver)
void	kvPrewrite(Kvrpcpb.PrewriteRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.PrewriteResponse> responseObserver)
void	kvResolveLock(Kvrpcpb.ResolveLockRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.ResolveLockResponse> responseObserver)
void	kvScan(Kvrpcpb.ScanRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.ScanResponse> responseObserver)
void	kvScanLock(Kvrpcpb.ScanLockRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.ScanLockResponse> responseObserver)
void	kvTxnHeartBeat(Kvrpcpb.TxnHeartBeatRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.TxnHeartBeatResponse> responseObserver)
void	mvccGetByKey(Kvrpcpb.MvccGetByKeyRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.MvccGetByKeyResponse> responseObserver) Commands for debugging transactions.
void	mvccGetByStartTs(Kvrpcpb.MvccGetByStartTsRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.MvccGetByStartTsResponse> responseObserver)
void	physicalScanLock(Kvrpcpb.PhysicalScanLockRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.PhysicalScanLockResponse> responseObserver)
io.grpc.stub.StreamObserver<RaftServerpb.RaftMessage>	raft(io.grpc.stub.StreamObserver<RaftServerpb.Done> responseObserver) Raft commands (sent between TiKV nodes).
void	rawBatchDelete(Kvrpcpb.RawBatchDeleteRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawBatchDeleteResponse> responseObserver)
void	rawBatchGet(Kvrpcpb.RawBatchGetRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawBatchGetResponse> responseObserver)
void	rawBatchPut(Kvrpcpb.RawBatchPutRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawBatchPutResponse> responseObserver)
void	rawBatchScan(Kvrpcpb.RawBatchScanRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawBatchScanResponse> responseObserver)
void	rawChecksum(Kvrpcpb.RawChecksumRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawChecksumResponse> responseObserver)
void	rawCompareAndSwap(Kvrpcpb.RawCASRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawCASResponse> responseObserver) Compare if the value in database equals to `RawCASRequest.previous_value` before putting the new value.
void	rawCoprocessor(Kvrpcpb.RawCoprocessorRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawCoprocessorResponse> responseObserver) Command for executing custom user requests in TiKV coprocessor_v2.
void	rawDelete(Kvrpcpb.RawDeleteRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawDeleteResponse> responseObserver)
void	rawDeleteRange(Kvrpcpb.RawDeleteRangeRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawDeleteRangeResponse> responseObserver)
void	rawGet(Kvrpcpb.RawGetRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawGetResponse> responseObserver) Raw commands; no transaction support.
void	rawGetKeyTTL(Kvrpcpb.RawGetKeyTTLRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawGetKeyTTLResponse> responseObserver) Get TTL of the key.
void	rawPut(Kvrpcpb.RawPutRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawPutResponse> responseObserver)
void	rawScan(Kvrpcpb.RawScanRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RawScanResponse> responseObserver)
void	readIndex(Kvrpcpb.ReadIndexRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.ReadIndexResponse> responseObserver) Sent from TiFlash or TiKV to a TiKV node.
void	registerLockObserver(Kvrpcpb.RegisterLockObserverRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RegisterLockObserverResponse> responseObserver)
void	removeLockObserver(Kvrpcpb.RemoveLockObserverRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.RemoveLockObserverResponse> responseObserver)
io.grpc.stub.StreamObserver<RaftServerpb.SnapshotChunk>	snapshot(io.grpc.stub.StreamObserver<RaftServerpb.Done> responseObserver)
void	splitRegion(Kvrpcpb.SplitRegionRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.SplitRegionResponse> responseObserver) Sent from PD or TiDB to a TiKV node.
void	unsafeDestroyRange(Kvrpcpb.UnsafeDestroyRangeRequest request, io.grpc.stub.StreamObserver<Kvrpcpb.UnsafeDestroyRangeResponse> responseObserver) Store commands (sent to a each TiKV node in a cluster, rather than a certain region).

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

Specified by:

build in class io.grpc.stub.AbstractStub<TikvGrpc.TikvStub>

kvGet

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

 Commands using a transactional interface.
 

kvScan

public void kvScan(Kvrpcpb.ScanRequest request,
                   io.grpc.stub.StreamObserver<Kvrpcpb.ScanResponse> responseObserver)

kvPrewrite

public void kvPrewrite(Kvrpcpb.PrewriteRequest request,
                       io.grpc.stub.StreamObserver<Kvrpcpb.PrewriteResponse> responseObserver)

kvPessimisticLock

public void kvPessimisticLock(Kvrpcpb.PessimisticLockRequest request,
                              io.grpc.stub.StreamObserver<Kvrpcpb.PessimisticLockResponse> responseObserver)

kVPessimisticRollback

public void kVPessimisticRollback(Kvrpcpb.PessimisticRollbackRequest request,
                                  io.grpc.stub.StreamObserver<Kvrpcpb.PessimisticRollbackResponse> responseObserver)

kvTxnHeartBeat

public void kvTxnHeartBeat(Kvrpcpb.TxnHeartBeatRequest request,
                           io.grpc.stub.StreamObserver<Kvrpcpb.TxnHeartBeatResponse> responseObserver)

kvCheckTxnStatus

public void kvCheckTxnStatus(Kvrpcpb.CheckTxnStatusRequest request,
                             io.grpc.stub.StreamObserver<Kvrpcpb.CheckTxnStatusResponse> responseObserver)

kvCheckSecondaryLocks

public void kvCheckSecondaryLocks(Kvrpcpb.CheckSecondaryLocksRequest request,
                                  io.grpc.stub.StreamObserver<Kvrpcpb.CheckSecondaryLocksResponse> responseObserver)

kvCommit

public void kvCommit(Kvrpcpb.CommitRequest request,
                     io.grpc.stub.StreamObserver<Kvrpcpb.CommitResponse> responseObserver)

kvImport

public void kvImport(Kvrpcpb.ImportRequest request,
                     io.grpc.stub.StreamObserver<Kvrpcpb.ImportResponse> responseObserver)

kvCleanup

public void kvCleanup(Kvrpcpb.CleanupRequest request,
                      io.grpc.stub.StreamObserver<Kvrpcpb.CleanupResponse> responseObserver)

kvBatchGet

public void kvBatchGet(Kvrpcpb.BatchGetRequest request,
                       io.grpc.stub.StreamObserver<Kvrpcpb.BatchGetResponse> responseObserver)

kvBatchRollback

public void kvBatchRollback(Kvrpcpb.BatchRollbackRequest request,
                            io.grpc.stub.StreamObserver<Kvrpcpb.BatchRollbackResponse> responseObserver)

kvScanLock

public void kvScanLock(Kvrpcpb.ScanLockRequest request,
                       io.grpc.stub.StreamObserver<Kvrpcpb.ScanLockResponse> responseObserver)

kvResolveLock

public void kvResolveLock(Kvrpcpb.ResolveLockRequest request,
                          io.grpc.stub.StreamObserver<Kvrpcpb.ResolveLockResponse> responseObserver)

kvGC

public void kvGC(Kvrpcpb.GCRequest request,
                 io.grpc.stub.StreamObserver<Kvrpcpb.GCResponse> responseObserver)

kvDeleteRange

public void kvDeleteRange(Kvrpcpb.DeleteRangeRequest request,
                          io.grpc.stub.StreamObserver<Kvrpcpb.DeleteRangeResponse> responseObserver)

rawGet

public void rawGet(Kvrpcpb.RawGetRequest request,
                   io.grpc.stub.StreamObserver<Kvrpcpb.RawGetResponse> responseObserver)

 Raw commands; no transaction support.
 

rawBatchGet

public void rawBatchGet(Kvrpcpb.RawBatchGetRequest request,
                        io.grpc.stub.StreamObserver<Kvrpcpb.RawBatchGetResponse> responseObserver)

rawPut

public void rawPut(Kvrpcpb.RawPutRequest request,
                   io.grpc.stub.StreamObserver<Kvrpcpb.RawPutResponse> responseObserver)

rawBatchPut

public void rawBatchPut(Kvrpcpb.RawBatchPutRequest request,
                        io.grpc.stub.StreamObserver<Kvrpcpb.RawBatchPutResponse> responseObserver)

rawDelete

public void rawDelete(Kvrpcpb.RawDeleteRequest request,
                      io.grpc.stub.StreamObserver<Kvrpcpb.RawDeleteResponse> responseObserver)

rawBatchDelete

public void rawBatchDelete(Kvrpcpb.RawBatchDeleteRequest request,
                           io.grpc.stub.StreamObserver<Kvrpcpb.RawBatchDeleteResponse> responseObserver)

rawScan

public void rawScan(Kvrpcpb.RawScanRequest request,
                    io.grpc.stub.StreamObserver<Kvrpcpb.RawScanResponse> responseObserver)

rawDeleteRange

public void rawDeleteRange(Kvrpcpb.RawDeleteRangeRequest request,
                           io.grpc.stub.StreamObserver<Kvrpcpb.RawDeleteRangeResponse> responseObserver)

rawBatchScan

public void rawBatchScan(Kvrpcpb.RawBatchScanRequest request,
                         io.grpc.stub.StreamObserver<Kvrpcpb.RawBatchScanResponse> responseObserver)

rawGetKeyTTL

public void rawGetKeyTTL(Kvrpcpb.RawGetKeyTTLRequest request,
                         io.grpc.stub.StreamObserver<Kvrpcpb.RawGetKeyTTLResponse> responseObserver)

 Get TTL of the key. Returns 0 if TTL is not set for the key.
 

rawCompareAndSwap

public void rawCompareAndSwap(Kvrpcpb.RawCASRequest request,
                              io.grpc.stub.StreamObserver<Kvrpcpb.RawCASResponse> responseObserver)

 Compare if the value in database equals to `RawCASRequest.previous_value` before putting the new value. If not, this request will have no effect and the value in the database will be returned.
 

rawChecksum

public void rawChecksum(Kvrpcpb.RawChecksumRequest request,
                        io.grpc.stub.StreamObserver<Kvrpcpb.RawChecksumResponse> responseObserver)

unsafeDestroyRange

public void unsafeDestroyRange(Kvrpcpb.UnsafeDestroyRangeRequest request,
                               io.grpc.stub.StreamObserver<Kvrpcpb.UnsafeDestroyRangeResponse> responseObserver)

 Store commands (sent to a each TiKV node in a cluster, rather than a certain region).
 

registerLockObserver

public void registerLockObserver(Kvrpcpb.RegisterLockObserverRequest request,
                                 io.grpc.stub.StreamObserver<Kvrpcpb.RegisterLockObserverResponse> responseObserver)

checkLockObserver

public void checkLockObserver(Kvrpcpb.CheckLockObserverRequest request,
                              io.grpc.stub.StreamObserver<Kvrpcpb.CheckLockObserverResponse> responseObserver)

removeLockObserver

public void removeLockObserver(Kvrpcpb.RemoveLockObserverRequest request,
                               io.grpc.stub.StreamObserver<Kvrpcpb.RemoveLockObserverResponse> responseObserver)

physicalScanLock

public void physicalScanLock(Kvrpcpb.PhysicalScanLockRequest request,
                             io.grpc.stub.StreamObserver<Kvrpcpb.PhysicalScanLockResponse> responseObserver)

coprocessor

public void coprocessor(Coprocessor.Request request,
                        io.grpc.stub.StreamObserver<Coprocessor.Response> responseObserver)

 Commands for executing SQL in the TiKV coprocessor (i.e., 'pushed down' to TiKV rather than
 executed in TiDB).
 

coprocessorStream

public void coprocessorStream(Coprocessor.Request request,
                              io.grpc.stub.StreamObserver<Coprocessor.Response> responseObserver)

batchCoprocessor

public void batchCoprocessor(Coprocessor.BatchRequest request,
                             io.grpc.stub.StreamObserver<Coprocessor.BatchResponse> responseObserver)

rawCoprocessor

public void rawCoprocessor(Kvrpcpb.RawCoprocessorRequest request,
                           io.grpc.stub.StreamObserver<Kvrpcpb.RawCoprocessorResponse> responseObserver)

 Command for executing custom user requests in TiKV coprocessor_v2.
 

raft

public io.grpc.stub.StreamObserver<RaftServerpb.RaftMessage> raft(io.grpc.stub.StreamObserver<RaftServerpb.Done> responseObserver)

 Raft commands (sent between TiKV nodes).
 

batchRaft

public io.grpc.stub.StreamObserver<Tikvpb.BatchRaftMessage> batchRaft(io.grpc.stub.StreamObserver<RaftServerpb.Done> responseObserver)

snapshot

public io.grpc.stub.StreamObserver<RaftServerpb.SnapshotChunk> snapshot(io.grpc.stub.StreamObserver<RaftServerpb.Done> responseObserver)

splitRegion

public void splitRegion(Kvrpcpb.SplitRegionRequest request,
                        io.grpc.stub.StreamObserver<Kvrpcpb.SplitRegionResponse> responseObserver)

 Sent from PD or TiDB to a TiKV node.
 

readIndex

public void readIndex(Kvrpcpb.ReadIndexRequest request,
                      io.grpc.stub.StreamObserver<Kvrpcpb.ReadIndexResponse> responseObserver)

 Sent from TiFlash or TiKV to a TiKV node.
 

mvccGetByKey

public void mvccGetByKey(Kvrpcpb.MvccGetByKeyRequest request,
                         io.grpc.stub.StreamObserver<Kvrpcpb.MvccGetByKeyResponse> responseObserver)

 Commands for debugging transactions.
 

mvccGetByStartTs

public void mvccGetByStartTs(Kvrpcpb.MvccGetByStartTsRequest request,
                             io.grpc.stub.StreamObserver<Kvrpcpb.MvccGetByStartTsResponse> responseObserver)

batchCommands

public io.grpc.stub.StreamObserver<Tikvpb.BatchCommandsRequest> batchCommands(io.grpc.stub.StreamObserver<Tikvpb.BatchCommandsResponse> responseObserver)

 Batched commands.
 

dispatchMPPTask

public void dispatchMPPTask(Mpp.DispatchTaskRequest request,
                            io.grpc.stub.StreamObserver<Mpp.DispatchTaskResponse> responseObserver)

 These are for mpp execution.
 

cancelMPPTask

public void cancelMPPTask(Mpp.CancelTaskRequest request,
                          io.grpc.stub.StreamObserver<Mpp.CancelTaskResponse> responseObserver)

establishMPPConnection

public void establishMPPConnection(Mpp.EstablishMPPConnectionRequest request,
                                   io.grpc.stub.StreamObserver<Mpp.MPPDataPacket> responseObserver)

isAlive

public void isAlive(Mpp.IsAliveRequest request,
                    io.grpc.stub.StreamObserver<Mpp.IsAliveResponse> responseObserver)

checkLeader

public void checkLeader(Kvrpcpb.CheckLeaderRequest request,
                        io.grpc.stub.StreamObserver<Kvrpcpb.CheckLeaderResponse> responseObserver)

/ CheckLeader sends all information (includes region term and epoch) to other stores.
 / Once a store receives a request, it checks term and epoch for each region, and sends the regions whose
 / term and epoch match with local information in the store.
 / After the client collected all responses from all stores, it checks if got a quorum of responses from
 / other stores for every region, and decides to advance resolved ts from these regions.
 

getStoreSafeTS

public void getStoreSafeTS(Kvrpcpb.StoreSafeTSRequest request,
                           io.grpc.stub.StreamObserver<Kvrpcpb.StoreSafeTSResponse> responseObserver)

/ Get the minimal `safe_ts` from regions at the store
 

getLockWaitInfo

public void getLockWaitInfo(Kvrpcpb.GetLockWaitInfoRequest request,
                            io.grpc.stub.StreamObserver<Kvrpcpb.GetLockWaitInfoResponse> responseObserver)

/ Get the information about lock waiting from TiKV.