org.tikv.common.region

Class RegionStoreClient

java.lang.Object

org.tikv.common.AbstractGRPCClient<TikvGrpc.TikvBlockingStub,TikvGrpc.TikvFutureStub>

org.tikv.common.region.AbstractRegionStoreClient

org.tikv.common.region.RegionStoreClient

All Implemented Interfaces:

AutoCloseable, RegionErrorReceiver

public class RegionStoreClient
extends AbstractRegionStoreClient

Note that RegionStoreClient itself is not thread-safe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionStoreClient.RegionStoreClientBuilder
static class	RegionStoreClient.RequestTypes

Field Summary

Fields

Modifier and Type	Field and Description
static io.prometheus.client.Histogram	GRPC_RAW_REQUEST_LATENCY
AbstractLockResolverClient	lockResolverClient

Fields inherited from class org.tikv.common.region.AbstractRegionStoreClient

codec, region, regionManager, SEEK_LEADER_STORE_DURATION, SEEK_PROXY_STORE_DURATION, store

Fields inherited from class org.tikv.common.AbstractGRPCClient

asyncStub, blockingStub, channelFactory, conf, timeout

Method Summary

Modifier and Type	Method and Description
boolean	addResolvedLocks(Long version, Set<Long> locks)
List<Kvrpcpb.KvPair>	batchGet(BackOffer backOffer, List<com.google.protobuf.ByteString> keys, long version)
void	commit(BackOffer backOffer, Iterable<com.google.protobuf.ByteString> keys, long startTs, long commitTs) Commit batch keys
List<RangeSplitter.RegionTask>	coprocess(BackOffer backOffer, DAGRequest req, List<Coprocessor.KeyRange> ranges, Queue<SelectResponse> responseQueue, long startTs) Execute and retrieve the response from TiKV server.
Iterator<SelectResponse>	coprocessStreaming(DAGRequest req, List<Coprocessor.KeyRange> ranges, long startTs)
com.google.protobuf.ByteString	get(BackOffer backOffer, com.google.protobuf.ByteString key, long version) Fetch a value according to a key
Set<Long>	getResolvedLocks(Long version)
void	prewrite(BackOffer backOffer, com.google.protobuf.ByteString primary, List<Kvrpcpb.Mutation> mutations, long startTs, long lockTTL) Prewrite batch keys
void	prewrite(BackOffer bo, com.google.protobuf.ByteString primaryLock, List<Kvrpcpb.Mutation> mutations, long startTs, long ttl, boolean skipConstraintCheck) Prewrite batch keys
void	rawBatchDelete(BackOffer backoffer, List<com.google.protobuf.ByteString> keys, boolean atomicForCAS)
List<Kvrpcpb.KvPair>	rawBatchGet(BackOffer backoffer, List<com.google.protobuf.ByteString> keys)
void	rawBatchPut(BackOffer backOffer, Batch batch, long ttl, boolean atomicForCAS)
void	rawBatchPut(BackOffer backOffer, List<Kvrpcpb.KvPair> kvPairs, long ttl, boolean atomicForCAS)
void	rawCompareAndSet(BackOffer backOffer, com.google.protobuf.ByteString key, Optional<com.google.protobuf.ByteString> prevValue, com.google.protobuf.ByteString value, long ttl)
void	rawDelete(BackOffer backOffer, com.google.protobuf.ByteString key, boolean atomicForCAS)
void	rawDeleteRange(BackOffer backOffer, com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey) Delete raw keys in the range of [startKey, endKey)
Optional<com.google.protobuf.ByteString>	rawGet(BackOffer backOffer, com.google.protobuf.ByteString key)
Optional<Long>	rawGetKeyTTL(BackOffer backOffer, com.google.protobuf.ByteString key)
void	rawPut(BackOffer backOffer, com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long ttl, boolean atomicForCAS)
List<Kvrpcpb.KvPair>	rawScan(BackOffer backOffer, com.google.protobuf.ByteString key, boolean keyOnly)
List<Kvrpcpb.KvPair>	rawScan(BackOffer backOffer, com.google.protobuf.ByteString key, int limit, boolean keyOnly) Return a batch KvPair list containing limited key-value pairs starting from `key`, which are in the same region
List<Kvrpcpb.KvPair>	scan(BackOffer backOffer, com.google.protobuf.ByteString startKey, long version)
List<Kvrpcpb.KvPair>	scan(BackOffer backOffer, com.google.protobuf.ByteString startKey, long version, boolean keyOnly)
List<Metapb.Region>	splitRegion(List<com.google.protobuf.ByteString> splitKeys) Send SplitRegion request to tikv split a region at splitKey.
void	txnHeartBeat(BackOffer bo, com.google.protobuf.ByteString primaryLock, long startTs, long ttl) TXN Heart Beat: update primary key ttl

Methods inherited from class org.tikv.common.region.AbstractRegionStoreClient

close, getAsyncStub, getBlockingStub, getRegion, makeContext, makeContext, makeContext, makeContext, onNotLeader, onStoreUnreachable

Methods inherited from class org.tikv.common.AbstractGRPCClient

callAsyncWithRetry, callServerStreamingWithRetry, callWithRetry, checkHealth, getConf, getTimeout, setTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lockResolverClient

public final AbstractLockResolverClient lockResolverClient

GRPC_RAW_REQUEST_LATENCY

public static final io.prometheus.client.Histogram GRPC_RAW_REQUEST_LATENCY

Method Detail

addResolvedLocks

public boolean addResolvedLocks(Long version,
                                Set<Long> locks)

getResolvedLocks

public Set<Long> getResolvedLocks(Long version)

get

public com.google.protobuf.ByteString get(BackOffer backOffer,
                                          com.google.protobuf.ByteString key,
                                          long version)
                                   throws TiClientInternalException,
                                          KeyException

Fetch a value according to a key

Parameters:

backOffer - backOffer

key - key to fetch

version - key version

Returns:

value

Throws:

TiClientInternalException - TiSpark Client exception, unexpected

KeyException - Key may be locked

batchGet

public List<Kvrpcpb.KvPair> batchGet(BackOffer backOffer,
                                     List<com.google.protobuf.ByteString> keys,
                                     long version)

scan

public List<Kvrpcpb.KvPair> scan(BackOffer backOffer,
                                 com.google.protobuf.ByteString startKey,
                                 long version,
                                 boolean keyOnly)

scan

public List<Kvrpcpb.KvPair> scan(BackOffer backOffer,
                                 com.google.protobuf.ByteString startKey,
                                 long version)

prewrite

public void prewrite(BackOffer backOffer,
                     com.google.protobuf.ByteString primary,
                     List<Kvrpcpb.Mutation> mutations,
                     long startTs,
                     long lockTTL)
              throws TiClientInternalException,
                     KeyException,
                     RegionException

Prewrite batch keys

Parameters:

backOffer - backOffer

primary - primary lock of keys

mutations - batch key-values as mutations

startTs - startTs of prewrite

lockTTL - lock ttl

Throws:

TiClientInternalException - TiSpark Client exception, unexpected

KeyException - Key may be locked

RegionException - region error occurs

prewrite

public void prewrite(BackOffer bo,
                     com.google.protobuf.ByteString primaryLock,
                     List<Kvrpcpb.Mutation> mutations,
                     long startTs,
                     long ttl,
                     boolean skipConstraintCheck)
              throws TiClientInternalException,
                     KeyException,
                     RegionException

Prewrite batch keys

Parameters:

skipConstraintCheck - whether to skip constraint check

Throws:

TiClientInternalException

KeyException

RegionException

txnHeartBeat

public void txnHeartBeat(BackOffer bo,
                         com.google.protobuf.ByteString primaryLock,
                         long startTs,
                         long ttl)

TXN Heart Beat: update primary key ttl

commit

public void commit(BackOffer backOffer,
                   Iterable<com.google.protobuf.ByteString> keys,
                   long startTs,
                   long commitTs)
            throws KeyException

Commit batch keys

Parameters:

backOffer - backOffer

keys - keys to commit

startTs - start version

commitTs - commit version

Throws:

KeyException

coprocess

public List<RangeSplitter.RegionTask> coprocess(BackOffer backOffer,
                                                DAGRequest req,
                                                List<Coprocessor.KeyRange> ranges,
                                                Queue<SelectResponse> responseQueue,
                                                long startTs)

Execute and retrieve the response from TiKV server.

Parameters:

req - Select request to process

ranges - Key range list

Returns:

Remaining tasks of this request, if task split happens, null otherwise

coprocessStreaming

public Iterator<SelectResponse> coprocessStreaming(DAGRequest req,
                                                   List<Coprocessor.KeyRange> ranges,
                                                   long startTs)

splitRegion

public List<Metapb.Region> splitRegion(List<com.google.protobuf.ByteString> splitKeys)

Send SplitRegion request to tikv split a region at splitKey. splitKey must between current region's start key and end key.

Parameters:

splitKeys - is the split points for a specific region.

Returns:

a split region info.

rawGet

public Optional<com.google.protobuf.ByteString> rawGet(BackOffer backOffer,
                                                       com.google.protobuf.ByteString key)

rawGetKeyTTL

public Optional<Long> rawGetKeyTTL(BackOffer backOffer,
                                   com.google.protobuf.ByteString key)

rawDelete

public void rawDelete(BackOffer backOffer,
                      com.google.protobuf.ByteString key,
                      boolean atomicForCAS)

rawPut

public void rawPut(BackOffer backOffer,
                   com.google.protobuf.ByteString key,
                   com.google.protobuf.ByteString value,
                   long ttl,
                   boolean atomicForCAS)

rawCompareAndSet

public void rawCompareAndSet(BackOffer backOffer,
                             com.google.protobuf.ByteString key,
                             Optional<com.google.protobuf.ByteString> prevValue,
                             com.google.protobuf.ByteString value,
                             long ttl)
                      throws RawCASConflictException

Throws:

RawCASConflictException

rawBatchGet

public List<Kvrpcpb.KvPair> rawBatchGet(BackOffer backoffer,
                                        List<com.google.protobuf.ByteString> keys)

rawBatchPut

public void rawBatchPut(BackOffer backOffer,
                        List<Kvrpcpb.KvPair> kvPairs,
                        long ttl,
                        boolean atomicForCAS)

rawBatchPut

public void rawBatchPut(BackOffer backOffer,
                        Batch batch,
                        long ttl,
                        boolean atomicForCAS)

rawBatchDelete

public void rawBatchDelete(BackOffer backoffer,
                           List<com.google.protobuf.ByteString> keys,
                           boolean atomicForCAS)

rawScan

public List<Kvrpcpb.KvPair> rawScan(BackOffer backOffer,
                                    com.google.protobuf.ByteString key,
                                    int limit,
                                    boolean keyOnly)

Return a batch KvPair list containing limited key-value pairs starting from `key`, which are in the same region

Parameters:

backOffer - BackOffer

key - startKey

keyOnly - true if value of KvPair is not needed

Returns:

KvPair list

rawScan

public List<Kvrpcpb.KvPair> rawScan(BackOffer backOffer,
                                    com.google.protobuf.ByteString key,
                                    boolean keyOnly)

rawDeleteRange

public void rawDeleteRange(BackOffer backOffer,
                           com.google.protobuf.ByteString startKey,
                           com.google.protobuf.ByteString endKey)

Delete raw keys in the range of [startKey, endKey)

Parameters:

backOffer - BackOffer

startKey - startKey

endKey - endKey