org.tikv.txn

Class KVClient

java.lang.Object

org.tikv.txn.KVClient

All Implemented Interfaces:

AutoCloseable

public class KVClient
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Constructor and Description
KVClient(TiConfiguration conf, RegionStoreClient.RegionStoreClientBuilder clientBuilder, TiSession session)

Method Summary

Modifier and Type	Method and Description
List<Kvrpcpb.KvPair>	batchGet(BackOffer backOffer, List<com.google.protobuf.ByteString> keys, long version) Get a set of key-value pair by keys from TiKV
void	close()
com.google.protobuf.ByteString	get(com.google.protobuf.ByteString key, long version) Get a key-value pair from TiKV if key exists
void	ingest(List<Pair<com.google.protobuf.ByteString,com.google.protobuf.ByteString>> list)
List<Kvrpcpb.KvPair>	scan(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, long version) Scan key-value pairs from TiKV in range [startKey, endKey)
List<Kvrpcpb.KvPair>	scan(com.google.protobuf.ByteString startKey, long version)
List<Kvrpcpb.KvPair>	scan(com.google.protobuf.ByteString startKey, long version, int limit) Scan key-value pairs from TiKV in range [startKey, ♾), maximum to `limit` pairs

Methods inherited from class java.lang.Object

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

Constructor Detail

KVClient

public KVClient(TiConfiguration conf,
                RegionStoreClient.RegionStoreClientBuilder clientBuilder,
                TiSession session)

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

get

public com.google.protobuf.ByteString get(com.google.protobuf.ByteString key,
                                          long version)
                                   throws GrpcException

Get a key-value pair from TiKV if key exists

Parameters:

key - key

Returns:

a ByteString value if key exists, ByteString.EMPTY if key does not exist

Throws:

GrpcException

batchGet

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

Get a set of key-value pair by keys from TiKV

Parameters:

backOffer -

keys -

version -

Returns:

Throws:

GrpcException

scan

public List<Kvrpcpb.KvPair> scan(com.google.protobuf.ByteString startKey,
                                 com.google.protobuf.ByteString endKey,
                                 long version)
                          throws GrpcException

Scan key-value pairs from TiKV in range [startKey, endKey)

Parameters:

startKey - start key, inclusive

endKey - end key, exclusive

Returns:

list of key-value pairs in range

Throws:

GrpcException

scan

public List<Kvrpcpb.KvPair> scan(com.google.protobuf.ByteString startKey,
                                 long version,
                                 int limit)
                          throws GrpcException

Scan key-value pairs from TiKV in range [startKey, ♾), maximum to `limit` pairs

Parameters:

startKey - start key, inclusive

limit - limit of kv pairs

Returns:

list of key-value pairs in range

Throws:

GrpcException

scan

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

Throws:

GrpcException

ingest

public void ingest(List<Pair<com.google.protobuf.ByteString,com.google.protobuf.ByteString>> list)
            throws GrpcException

Throws:

GrpcException