org.tikv.kvproto

Class TikvGrpc.TikvFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<TikvGrpc.TikvFutureStub>

org.tikv.kvproto.TikvGrpc.TikvFutureStub

Enclosing class:

TikvGrpc

public static final class TikvGrpc.TikvFutureStub
extends io.grpc.stub.AbstractFutureStub<TikvGrpc.TikvFutureStub>

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

Methods inherited from class io.grpc.stub.AbstractFutureStub

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

Specified by:

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

kvGet

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.GetResponse> kvGet(Kvrpcpb.GetRequest request)

 Commands using a transactional interface.
 

kvScan

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.ScanResponse> kvScan(Kvrpcpb.ScanRequest request)

kvPrewrite

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.PrewriteResponse> kvPrewrite(Kvrpcpb.PrewriteRequest request)

kvPessimisticLock

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.PessimisticLockResponse> kvPessimisticLock(Kvrpcpb.PessimisticLockRequest request)

kVPessimisticRollback

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.PessimisticRollbackResponse> kVPessimisticRollback(Kvrpcpb.PessimisticRollbackRequest request)

kvTxnHeartBeat

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.TxnHeartBeatResponse> kvTxnHeartBeat(Kvrpcpb.TxnHeartBeatRequest request)

kvCheckTxnStatus

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.CheckTxnStatusResponse> kvCheckTxnStatus(Kvrpcpb.CheckTxnStatusRequest request)

kvCheckSecondaryLocks

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.CheckSecondaryLocksResponse> kvCheckSecondaryLocks(Kvrpcpb.CheckSecondaryLocksRequest request)

kvCommit

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.CommitResponse> kvCommit(Kvrpcpb.CommitRequest request)

kvImport

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.ImportResponse> kvImport(Kvrpcpb.ImportRequest request)

kvCleanup

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.CleanupResponse> kvCleanup(Kvrpcpb.CleanupRequest request)

kvBatchGet

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.BatchGetResponse> kvBatchGet(Kvrpcpb.BatchGetRequest request)

kvBatchRollback

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.BatchRollbackResponse> kvBatchRollback(Kvrpcpb.BatchRollbackRequest request)

kvScanLock

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.ScanLockResponse> kvScanLock(Kvrpcpb.ScanLockRequest request)

kvResolveLock

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.ResolveLockResponse> kvResolveLock(Kvrpcpb.ResolveLockRequest request)

kvGC

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.GCResponse> kvGC(Kvrpcpb.GCRequest request)

kvDeleteRange

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.DeleteRangeResponse> kvDeleteRange(Kvrpcpb.DeleteRangeRequest request)

rawGet

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawGetResponse> rawGet(Kvrpcpb.RawGetRequest request)

 Raw commands; no transaction support.
 

rawBatchGet

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawBatchGetResponse> rawBatchGet(Kvrpcpb.RawBatchGetRequest request)

rawPut

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawPutResponse> rawPut(Kvrpcpb.RawPutRequest request)

rawBatchPut

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawBatchPutResponse> rawBatchPut(Kvrpcpb.RawBatchPutRequest request)

rawDelete

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawDeleteResponse> rawDelete(Kvrpcpb.RawDeleteRequest request)

rawBatchDelete

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawBatchDeleteResponse> rawBatchDelete(Kvrpcpb.RawBatchDeleteRequest request)

rawScan

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawScanResponse> rawScan(Kvrpcpb.RawScanRequest request)

rawDeleteRange

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawDeleteRangeResponse> rawDeleteRange(Kvrpcpb.RawDeleteRangeRequest request)

rawBatchScan

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawBatchScanResponse> rawBatchScan(Kvrpcpb.RawBatchScanRequest request)

rawGetKeyTTL

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawGetKeyTTLResponse> rawGetKeyTTL(Kvrpcpb.RawGetKeyTTLRequest request)

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

rawCompareAndSwap

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawCASResponse> rawCompareAndSwap(Kvrpcpb.RawCASRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawChecksumResponse> rawChecksum(Kvrpcpb.RawChecksumRequest request)

unsafeDestroyRange

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.UnsafeDestroyRangeResponse> unsafeDestroyRange(Kvrpcpb.UnsafeDestroyRangeRequest request)

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

registerLockObserver

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RegisterLockObserverResponse> registerLockObserver(Kvrpcpb.RegisterLockObserverRequest request)

checkLockObserver

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.CheckLockObserverResponse> checkLockObserver(Kvrpcpb.CheckLockObserverRequest request)

removeLockObserver

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RemoveLockObserverResponse> removeLockObserver(Kvrpcpb.RemoveLockObserverRequest request)

physicalScanLock

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.PhysicalScanLockResponse> physicalScanLock(Kvrpcpb.PhysicalScanLockRequest request)

coprocessor

public com.google.common.util.concurrent.ListenableFuture<Coprocessor.Response> coprocessor(Coprocessor.Request request)

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

rawCoprocessor

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.RawCoprocessorResponse> rawCoprocessor(Kvrpcpb.RawCoprocessorRequest request)

 Command for executing custom user requests in TiKV coprocessor_v2.
 

splitRegion

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.SplitRegionResponse> splitRegion(Kvrpcpb.SplitRegionRequest request)

 Sent from PD or TiDB to a TiKV node.
 

readIndex

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.ReadIndexResponse> readIndex(Kvrpcpb.ReadIndexRequest request)

 Sent from TiFlash or TiKV to a TiKV node.
 

mvccGetByKey

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.MvccGetByKeyResponse> mvccGetByKey(Kvrpcpb.MvccGetByKeyRequest request)

 Commands for debugging transactions.
 

mvccGetByStartTs

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.MvccGetByStartTsResponse> mvccGetByStartTs(Kvrpcpb.MvccGetByStartTsRequest request)

dispatchMPPTask

public com.google.common.util.concurrent.ListenableFuture<Mpp.DispatchTaskResponse> dispatchMPPTask(Mpp.DispatchTaskRequest request)

 These are for mpp execution.
 

cancelMPPTask

public com.google.common.util.concurrent.ListenableFuture<Mpp.CancelTaskResponse> cancelMPPTask(Mpp.CancelTaskRequest request)

isAlive

public com.google.common.util.concurrent.ListenableFuture<Mpp.IsAliveResponse> isAlive(Mpp.IsAliveRequest request)

checkLeader

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.CheckLeaderResponse> checkLeader(Kvrpcpb.CheckLeaderRequest request)

/ 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 com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.StoreSafeTSResponse> getStoreSafeTS(Kvrpcpb.StoreSafeTSRequest request)

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

getLockWaitInfo

public com.google.common.util.concurrent.ListenableFuture<Kvrpcpb.GetLockWaitInfoResponse> getLockWaitInfo(Kvrpcpb.GetLockWaitInfoRequest request)

/ Get the information about lock waiting from TiKV.