org.tikv.kvproto

Interface TikvGrpc.AsyncService

All Known Implementing Classes:

TikvGrpc.TikvImplBase

Enclosing class:

TikvGrpc

public static interface TikvGrpc.AsyncService

 Key/value store API for TiKV.
 

Method Summary

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

Method Detail

kvGet

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

 Commands using a transactional interface.
 

kvScan

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

kvPrewrite

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

kvPessimisticLock

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

kVPessimisticRollback

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

kvTxnHeartBeat

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

kvCheckTxnStatus

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

kvCheckSecondaryLocks

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

kvCommit

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

kvImport

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

kvCleanup

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

kvBatchGet

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

kvBatchRollback

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

kvScanLock

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

kvResolveLock

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

kvGC

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

kvDeleteRange

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

rawGet

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

 Raw commands; no transaction support.
 

rawBatchGet

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

rawPut

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

rawBatchPut

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

rawDelete

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

rawBatchDelete

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

rawScan

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

rawDeleteRange

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

rawBatchScan

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

rawGetKeyTTL

default 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

default 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

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

unsafeDestroyRange

default 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

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

checkLockObserver

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

removeLockObserver

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

physicalScanLock

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

coprocessor

default 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

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

batchCoprocessor

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

rawCoprocessor

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

 Command for executing custom user requests in TiKV coprocessor_v2.
 

raft

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

 Raft commands (sent between TiKV nodes).
 

batchRaft

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

snapshot

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

splitRegion

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

 Sent from PD or TiDB to a TiKV node.
 

readIndex

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

 Sent from TiFlash or TiKV to a TiKV node.
 

mvccGetByKey

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

 Commands for debugging transactions.
 

mvccGetByStartTs

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

batchCommands

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

 Batched commands.
 

dispatchMPPTask

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

 These are for mpp execution.
 

cancelMPPTask

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

establishMPPConnection

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

isAlive

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

checkLeader

default 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

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

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

getLockWaitInfo

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

/ Get the information about lock waiting from TiKV.