org.tikv.kvproto

Class TikvGrpc.TikvBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<TikvGrpc.TikvBlockingStub>

org.tikv.kvproto.TikvGrpc.TikvBlockingStub

Enclosing class:

TikvGrpc

public static final class TikvGrpc.TikvBlockingStub
extends io.grpc.stub.AbstractBlockingStub<TikvGrpc.TikvBlockingStub>

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

Specified by:

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

kvGet

public Kvrpcpb.GetResponse kvGet(Kvrpcpb.GetRequest request)

 Commands using a transactional interface.
 

kvScan

public Kvrpcpb.ScanResponse kvScan(Kvrpcpb.ScanRequest request)

kvPrewrite

public Kvrpcpb.PrewriteResponse kvPrewrite(Kvrpcpb.PrewriteRequest request)

kvPessimisticLock

public Kvrpcpb.PessimisticLockResponse kvPessimisticLock(Kvrpcpb.PessimisticLockRequest request)

kVPessimisticRollback

public Kvrpcpb.PessimisticRollbackResponse kVPessimisticRollback(Kvrpcpb.PessimisticRollbackRequest request)

kvTxnHeartBeat

public Kvrpcpb.TxnHeartBeatResponse kvTxnHeartBeat(Kvrpcpb.TxnHeartBeatRequest request)

kvCheckTxnStatus

public Kvrpcpb.CheckTxnStatusResponse kvCheckTxnStatus(Kvrpcpb.CheckTxnStatusRequest request)

kvCheckSecondaryLocks

public Kvrpcpb.CheckSecondaryLocksResponse kvCheckSecondaryLocks(Kvrpcpb.CheckSecondaryLocksRequest request)

kvCommit

public Kvrpcpb.CommitResponse kvCommit(Kvrpcpb.CommitRequest request)

kvImport

public Kvrpcpb.ImportResponse kvImport(Kvrpcpb.ImportRequest request)

kvCleanup

public Kvrpcpb.CleanupResponse kvCleanup(Kvrpcpb.CleanupRequest request)

kvBatchGet

public Kvrpcpb.BatchGetResponse kvBatchGet(Kvrpcpb.BatchGetRequest request)

kvBatchRollback

public Kvrpcpb.BatchRollbackResponse kvBatchRollback(Kvrpcpb.BatchRollbackRequest request)

kvScanLock

public Kvrpcpb.ScanLockResponse kvScanLock(Kvrpcpb.ScanLockRequest request)

kvResolveLock

public Kvrpcpb.ResolveLockResponse kvResolveLock(Kvrpcpb.ResolveLockRequest request)

kvGC

public Kvrpcpb.GCResponse kvGC(Kvrpcpb.GCRequest request)

kvDeleteRange

public Kvrpcpb.DeleteRangeResponse kvDeleteRange(Kvrpcpb.DeleteRangeRequest request)

rawGet

public Kvrpcpb.RawGetResponse rawGet(Kvrpcpb.RawGetRequest request)

 Raw commands; no transaction support.
 

rawBatchGet

public Kvrpcpb.RawBatchGetResponse rawBatchGet(Kvrpcpb.RawBatchGetRequest request)

rawPut

public Kvrpcpb.RawPutResponse rawPut(Kvrpcpb.RawPutRequest request)

rawBatchPut

public Kvrpcpb.RawBatchPutResponse rawBatchPut(Kvrpcpb.RawBatchPutRequest request)

rawDelete

public Kvrpcpb.RawDeleteResponse rawDelete(Kvrpcpb.RawDeleteRequest request)

rawBatchDelete

public Kvrpcpb.RawBatchDeleteResponse rawBatchDelete(Kvrpcpb.RawBatchDeleteRequest request)

rawScan

public Kvrpcpb.RawScanResponse rawScan(Kvrpcpb.RawScanRequest request)

rawDeleteRange

public Kvrpcpb.RawDeleteRangeResponse rawDeleteRange(Kvrpcpb.RawDeleteRangeRequest request)

rawBatchScan

public Kvrpcpb.RawBatchScanResponse rawBatchScan(Kvrpcpb.RawBatchScanRequest request)

rawGetKeyTTL

public Kvrpcpb.RawGetKeyTTLResponse rawGetKeyTTL(Kvrpcpb.RawGetKeyTTLRequest request)

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

rawCompareAndSwap

public 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 Kvrpcpb.RawChecksumResponse rawChecksum(Kvrpcpb.RawChecksumRequest request)

unsafeDestroyRange

public Kvrpcpb.UnsafeDestroyRangeResponse unsafeDestroyRange(Kvrpcpb.UnsafeDestroyRangeRequest request)

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

registerLockObserver

public Kvrpcpb.RegisterLockObserverResponse registerLockObserver(Kvrpcpb.RegisterLockObserverRequest request)

checkLockObserver

public Kvrpcpb.CheckLockObserverResponse checkLockObserver(Kvrpcpb.CheckLockObserverRequest request)

removeLockObserver

public Kvrpcpb.RemoveLockObserverResponse removeLockObserver(Kvrpcpb.RemoveLockObserverRequest request)

physicalScanLock

public Kvrpcpb.PhysicalScanLockResponse physicalScanLock(Kvrpcpb.PhysicalScanLockRequest request)

coprocessor

public 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).
 

coprocessorStream

public Iterator<Coprocessor.Response> coprocessorStream(Coprocessor.Request request)

batchCoprocessor

public Iterator<Coprocessor.BatchResponse> batchCoprocessor(Coprocessor.BatchRequest request)

rawCoprocessor

public Kvrpcpb.RawCoprocessorResponse rawCoprocessor(Kvrpcpb.RawCoprocessorRequest request)

 Command for executing custom user requests in TiKV coprocessor_v2.
 

splitRegion

public Kvrpcpb.SplitRegionResponse splitRegion(Kvrpcpb.SplitRegionRequest request)

 Sent from PD or TiDB to a TiKV node.
 

readIndex

public Kvrpcpb.ReadIndexResponse readIndex(Kvrpcpb.ReadIndexRequest request)

 Sent from TiFlash or TiKV to a TiKV node.
 

mvccGetByKey

public Kvrpcpb.MvccGetByKeyResponse mvccGetByKey(Kvrpcpb.MvccGetByKeyRequest request)

 Commands for debugging transactions.
 

mvccGetByStartTs

public Kvrpcpb.MvccGetByStartTsResponse mvccGetByStartTs(Kvrpcpb.MvccGetByStartTsRequest request)

dispatchMPPTask

public Mpp.DispatchTaskResponse dispatchMPPTask(Mpp.DispatchTaskRequest request)

 These are for mpp execution.
 

cancelMPPTask

public Mpp.CancelTaskResponse cancelMPPTask(Mpp.CancelTaskRequest request)

establishMPPConnection

public Iterator<Mpp.MPPDataPacket> establishMPPConnection(Mpp.EstablishMPPConnectionRequest request)

isAlive

public Mpp.IsAliveResponse isAlive(Mpp.IsAliveRequest request)

checkLeader

public 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 Kvrpcpb.StoreSafeTSResponse getStoreSafeTS(Kvrpcpb.StoreSafeTSRequest request)

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

getLockWaitInfo

public Kvrpcpb.GetLockWaitInfoResponse getLockWaitInfo(Kvrpcpb.GetLockWaitInfoRequest request)

/ Get the information about lock waiting from TiKV.