org.tikv.raw

类 RawKVClient

java.lang.Object

org.tikv.raw.RawKVClient

所有已实现的接口:

AutoCloseable, RawKVClientBase

public class RawKVClient
extends Object
implements RawKVClientBase

嵌套类概要

嵌套类

限定符和类型	类和说明
class	RawKVClient.TikvIterator

字段概要

字段

限定符和类型	字段和说明
static io.prometheus.client.Counter	RAW_REQUEST_FAILURE
static io.prometheus.client.Histogram	RAW_REQUEST_LATENCY
static io.prometheus.client.Counter	RAW_REQUEST_SUCCESS

从接口继承的字段 org.tikv.raw.RawKVClientBase

MAX_RAW_BATCH_LIMIT, MAX_RAW_SCAN_LIMIT, RAW_BATCH_DELETE_SIZE, RAW_BATCH_GET_SIZE, RAW_BATCH_PUT_SIZE

构造器概要

构造器

构造器和说明
RawKVClient(TiSession session, RegionStoreClient.RegionStoreClientBuilder clientBuilder)

方法概要

限定符和类型	方法和说明
void	batchDelete(List<com.google.protobuf.ByteString> keys) Delete a list of raw key-value pair from TiKV if key exists
List<Kvrpcpb.KvPair>	batchGet(List<com.google.protobuf.ByteString> keys) Get a list of raw key-value pair from TiKV if key exists
void	batchPut(Map<com.google.protobuf.ByteString,com.google.protobuf.ByteString> kvPairs) Put a set of raw key-value pair to TiKV.
void	batchPut(Map<com.google.protobuf.ByteString,com.google.protobuf.ByteString> kvPairs, long ttl) Put a set of raw key-value pair to TiKV.
List<List<Kvrpcpb.KvPair>>	batchScan(List<ScanOption> ranges) Create a new `batch scan` request.
List<List<com.google.protobuf.ByteString>>	batchScanKeys(List<Pair<com.google.protobuf.ByteString,com.google.protobuf.ByteString>> ranges, int eachLimit) Create a new `batch scan` request with `keyOnly` option Once resolved this request will result in a set of scanners over the given keys.
void	close()
void	compareAndSet(com.google.protobuf.ByteString key, Optional<com.google.protobuf.ByteString> prevValue, com.google.protobuf.ByteString value) Put a key-value pair if the prevValue matched the value in TiKV.
void	compareAndSet(com.google.protobuf.ByteString key, Optional<com.google.protobuf.ByteString> prevValue, com.google.protobuf.ByteString value, long ttl) pair if the prevValue matched the value in TiKV.
void	delete(com.google.protobuf.ByteString key) Delete a raw key-value pair from TiKV if key exists
void	deletePrefix(com.google.protobuf.ByteString key) Delete all raw key-value pairs with the prefix `key` from TiKV Cautious, this API cannot be used concurrently, if multiple clients write keys into this range along with deleteRange API, the result will be undefined.
void	deleteRange(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey) Delete all raw key-value pairs in range [startKey, endKey) from TiKV Cautious, this API cannot be used concurrently, if multiple clients write keys into this range along with deleteRange API, the result will be undefined.
Optional<com.google.protobuf.ByteString>	get(com.google.protobuf.ByteString key) Get a raw key-value pair from TiKV if key exists
Optional<Long>	getKeyTTL(com.google.protobuf.ByteString key) Get the TTL of a raw key from TiKV if key exists
TiSession	getSession() Get the session of the current client
void	ingest(List<Pair<com.google.protobuf.ByteString,com.google.protobuf.ByteString>> list) Ingest KV pairs to RawKV using StreamKV API.
void	ingest(List<Pair<com.google.protobuf.ByteString,com.google.protobuf.ByteString>> list, Long ttl) Ingest KV pairs to RawKV using StreamKV API.
void	put(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value) Put a raw key-value pair to TiKV
void	put(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long ttl) Put a raw key-value pair to TiKV
Optional<com.google.protobuf.ByteString>	putIfAbsent(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value) Put a key-value pair if it does not exist.
Optional<com.google.protobuf.ByteString>	putIfAbsent(com.google.protobuf.ByteString key, com.google.protobuf.ByteString value, long ttl) Put a key-value pair with TTL if it does not exist.
List<Kvrpcpb.KvPair>	scan(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey) Scan all raw key-value pairs from TiKV in range [startKey, endKey)
List<Kvrpcpb.KvPair>	scan(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, boolean keyOnly) Scan all raw key-value pairs from TiKV in range [startKey, endKey)
List<Kvrpcpb.KvPair>	scan(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, int limit) Scan raw key-value pairs from TiKV in range [startKey, endKey)
List<Kvrpcpb.KvPair>	scan(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, int limit, boolean keyOnly) Scan raw key-value pairs from TiKV in range [startKey, endKey)
List<Kvrpcpb.KvPair>	scan(com.google.protobuf.ByteString startKey, int limit) Scan raw key-value pairs from TiKV in range [startKey, ♾)
List<Kvrpcpb.KvPair>	scan(com.google.protobuf.ByteString startKey, int limit, boolean keyOnly) Scan raw key-value pairs from TiKV in range [startKey, ♾)
Iterator<Kvrpcpb.KvPair>	scan0(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey) Scan all raw key-value pairs from TiKV in range [startKey, endKey)
Iterator<Kvrpcpb.KvPair>	scan0(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, boolean keyOnly) Scan all raw key-value pairs from TiKV in range [startKey, endKey)
Iterator<Kvrpcpb.KvPair>	scan0(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, int limit) Scan raw key-value pairs from TiKV in range [startKey, endKey)
Iterator<Kvrpcpb.KvPair>	scan0(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey, int limit, boolean keyOnly) Scan raw key-value pairs from TiKV in range [startKey, endKey)
Iterator<Kvrpcpb.KvPair>	scan0(com.google.protobuf.ByteString startKey, int limit) Scan raw key-value pairs from TiKV in range [startKey, ♾)
Iterator<Kvrpcpb.KvPair>	scan0(com.google.protobuf.ByteString startKey, int limit, boolean keyOnly) Scan raw key-value pairs from TiKV in range [startKey, ♾)
List<Kvrpcpb.KvPair>	scanPrefix(com.google.protobuf.ByteString prefixKey)
List<Kvrpcpb.KvPair>	scanPrefix(com.google.protobuf.ByteString prefixKey, boolean keyOnly)
List<Kvrpcpb.KvPair>	scanPrefix(com.google.protobuf.ByteString prefixKey, int limit, boolean keyOnly) Scan keys with prefix
Iterator<Kvrpcpb.KvPair>	scanPrefix0(com.google.protobuf.ByteString prefixKey)
Iterator<Kvrpcpb.KvPair>	scanPrefix0(com.google.protobuf.ByteString prefixKey, boolean keyOnly)
Iterator<Kvrpcpb.KvPair>	scanPrefix0(com.google.protobuf.ByteString prefixKey, int limit, boolean keyOnly) Scan keys with prefix

从类继承的方法 java.lang.Object

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

字段详细资料

RAW_REQUEST_LATENCY

public static final io.prometheus.client.Histogram RAW_REQUEST_LATENCY

RAW_REQUEST_SUCCESS

public static final io.prometheus.client.Counter RAW_REQUEST_SUCCESS

RAW_REQUEST_FAILURE

public static final io.prometheus.client.Counter RAW_REQUEST_FAILURE

构造器详细资料

RawKVClient

public RawKVClient(TiSession session,
                   RegionStoreClient.RegionStoreClientBuilder clientBuilder)

方法详细资料

close

public void close()

指定者:

close 在接口中 AutoCloseable

put

public void put(com.google.protobuf.ByteString key,
                com.google.protobuf.ByteString value)

从接口复制的说明: RawKVClientBase

Put a raw key-value pair to TiKV

指定者:

put 在接口中 RawKVClientBase

参数:

key - raw key

value - raw value

put

public void put(com.google.protobuf.ByteString key,
                com.google.protobuf.ByteString value,
                long ttl)

从接口复制的说明: RawKVClientBase

Put a raw key-value pair to TiKV

指定者:

put 在接口中 RawKVClientBase

参数:

key - raw key

value - raw value

ttl - the ttl of the key (in seconds), 0 means the key will never be outdated

putIfAbsent

public Optional<com.google.protobuf.ByteString> putIfAbsent(com.google.protobuf.ByteString key,
                                                            com.google.protobuf.ByteString value)

从接口复制的说明: RawKVClientBase

Put a key-value pair if it does not exist. This API is atomic.

To use this API, please enable `tikv.enable_atomic_for_cas`.

指定者:

putIfAbsent 在接口中 RawKVClientBase

参数:

key - key

value - value

返回:

a ByteString. returns Optional.EMPTY if the value is written successfully. returns the previous key if the value already exists, and does not write to TiKV.

putIfAbsent

public Optional<com.google.protobuf.ByteString> putIfAbsent(com.google.protobuf.ByteString key,
                                                            com.google.protobuf.ByteString value,
                                                            long ttl)

从接口复制的说明: RawKVClientBase

Put a key-value pair with TTL if it does not exist. This API is atomic.

To use this API, please enable `tikv.enable_atomic_for_cas`.

指定者:

putIfAbsent 在接口中 RawKVClientBase

参数:

key - key

value - value

ttl - TTL of key (in seconds), 0 means the key will never be outdated.

返回:

a ByteString. returns Optional.EMPTY if the value is written successfully. returns the previous key if the value already exists, and does not write to TiKV.

compareAndSet

public void compareAndSet(com.google.protobuf.ByteString key,
                          Optional<com.google.protobuf.ByteString> prevValue,
                          com.google.protobuf.ByteString value)
                   throws RawCASConflictException

从接口复制的说明: RawKVClientBase

Put a key-value pair if the prevValue matched the value in TiKV. This API is atomic.

To use this API, please enable `tikv.enable_atomic_for_cas`.

指定者:

compareAndSet 在接口中 RawKVClientBase

参数:

key - key

value - value

抛出:

RawCASConflictException

compareAndSet

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

从接口复制的说明: RawKVClientBase

pair if the prevValue matched the value in TiKV. This API is atomic.

To use this API, please enable `tikv.enable_atomic_for_cas`.

指定者:

compareAndSet 在接口中 RawKVClientBase

参数:

key - key

value - value

ttl - TTL of key (in seconds), 0 means the key will never be outdated.

抛出:

RawCASConflictException

batchPut

public void batchPut(Map<com.google.protobuf.ByteString,com.google.protobuf.ByteString> kvPairs)

从接口复制的说明: RawKVClientBase

Put a set of raw key-value pair to TiKV.

指定者:

batchPut 在接口中 RawKVClientBase

参数:

kvPairs - kvPairs

batchPut

public void batchPut(Map<com.google.protobuf.ByteString,com.google.protobuf.ByteString> kvPairs,
                     long ttl)

从接口复制的说明: RawKVClientBase

Put a set of raw key-value pair to TiKV.

指定者:

batchPut 在接口中 RawKVClientBase

参数:

kvPairs - kvPairs

ttl - the TTL of keys to be put (in seconds), 0 means the keys will never be outdated

get

public Optional<com.google.protobuf.ByteString> get(com.google.protobuf.ByteString key)

从接口复制的说明: RawKVClientBase

Get a raw key-value pair from TiKV if key exists

指定者:

get 在接口中 RawKVClientBase

参数:

key - raw key

返回:

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

batchGet

public List<Kvrpcpb.KvPair> batchGet(List<com.google.protobuf.ByteString> keys)

从接口复制的说明: RawKVClientBase

Get a list of raw key-value pair from TiKV if key exists

指定者:

batchGet 在接口中 RawKVClientBase

参数:

keys - list of raw key

返回:

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

batchDelete

public void batchDelete(List<com.google.protobuf.ByteString> keys)

从接口复制的说明: RawKVClientBase

Delete a list of raw key-value pair from TiKV if key exists

指定者:

batchDelete 在接口中 RawKVClientBase

参数:

keys - list of raw key

getKeyTTL

public Optional<Long> getKeyTTL(com.google.protobuf.ByteString key)

从接口复制的说明: RawKVClientBase

Get the TTL of a raw key from TiKV if key exists

指定者:

getKeyTTL 在接口中 RawKVClientBase

参数:

key - raw key

返回:

a Long indicating the TTL of key ttl is a non-null long value indicating TTL if key exists. - ttl=0 if the key will never be outdated. - ttl=null if the key does not exist

batchScanKeys

public List<List<com.google.protobuf.ByteString>> batchScanKeys(List<Pair<com.google.protobuf.ByteString,com.google.protobuf.ByteString>> ranges,
                                                                int eachLimit)

从接口复制的说明: RawKVClientBase

Create a new `batch scan` request with `keyOnly` option Once resolved this request will result in a set of scanners over the given keys.

WARNING: This method is experimental. The `each_limit` parameter does not work as expected. It does not limit the number of results returned of each range, instead it limits the number of results in each region of each range. As a result, you may get more than each_limit key-value pairs for each range. But you should not miss any entries.

指定者:

batchScanKeys 在接口中 RawKVClientBase

参数:

ranges - a list of ranges

返回:

a set of scanners for keys over the given keys.

batchScan

public List<List<Kvrpcpb.KvPair>> batchScan(List<ScanOption> ranges)

从接口复制的说明: RawKVClientBase

Create a new `batch scan` request. Once resolved this request will result in a set of scanners over the given keys.

WARNING: This method is experimental. The `each_limit` parameter does not work as expected. It does not limit the number of results returned of each range, instead it limits the number of results in each region of each range. As a result, you may get more than each_limit key-value pairs for each range. But you should not miss any entries.

指定者:

batchScan 在接口中 RawKVClientBase

参数:

ranges - a list of `ScanOption` for each range

返回:

a set of scanners over the given keys.

scan

public List<Kvrpcpb.KvPair> scan(com.google.protobuf.ByteString startKey,
                                 com.google.protobuf.ByteString endKey,
                                 int limit)

从接口复制的说明: RawKVClientBase

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

指定者:

scan 在接口中 RawKVClientBase

参数:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

limit - limit of key-value pairs scanned, should be less than RawKVClientBase.MAX_RAW_SCAN_LIMIT

返回:

list of key-value pairs in range

scan

public List<Kvrpcpb.KvPair> scan(com.google.protobuf.ByteString startKey,
                                 com.google.protobuf.ByteString endKey,
                                 int limit,
                                 boolean keyOnly)

从接口复制的说明: RawKVClientBase

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

指定者:

scan 在接口中 RawKVClientBase

参数:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

limit - limit of key-value pairs scanned, should be less than RawKVClientBase.MAX_RAW_SCAN_LIMIT

keyOnly - whether to scan in key-only mode

返回:

list of key-value pairs in range

scan

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

从接口复制的说明: RawKVClientBase

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

指定者:

scan 在接口中 RawKVClientBase

参数:

startKey - raw start key, inclusive

limit - limit of key-value pairs scanned, should be less than RawKVClientBase.MAX_RAW_SCAN_LIMIT

返回:

list of key-value pairs in range

scan

public List<Kvrpcpb.KvPair> scan(com.google.protobuf.ByteString startKey,
                                 int limit,
                                 boolean keyOnly)

从接口复制的说明: RawKVClientBase

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

指定者:

scan 在接口中 RawKVClientBase

参数:

startKey - raw start key, inclusive

limit - limit of key-value pairs scanned, should be less than RawKVClientBase.MAX_RAW_SCAN_LIMIT

keyOnly - whether to scan in key-only mode

返回:

list of key-value pairs in range

scan

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

从接口复制的说明: RawKVClientBase

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

指定者:

scan 在接口中 RawKVClientBase

参数:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

返回:

list of key-value pairs in range

scan

public List<Kvrpcpb.KvPair> scan(com.google.protobuf.ByteString startKey,
                                 com.google.protobuf.ByteString endKey,
                                 boolean keyOnly)

从接口复制的说明: RawKVClientBase

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

指定者:

scan 在接口中 RawKVClientBase

参数:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

keyOnly - whether to scan in key-only mode

返回:

list of key-value pairs in range

scanPrefix

public List<Kvrpcpb.KvPair> scanPrefix(com.google.protobuf.ByteString prefixKey,
                                       int limit,
                                       boolean keyOnly)

从接口复制的说明: RawKVClientBase

Scan keys with prefix

指定者:

scanPrefix 在接口中 RawKVClientBase

参数:

prefixKey - prefix key

limit - limit of keys retrieved

keyOnly - whether to scan in keyOnly mode

返回:

kvPairs with the specified prefix

scanPrefix

public List<Kvrpcpb.KvPair> scanPrefix(com.google.protobuf.ByteString prefixKey)

指定者:

scanPrefix 在接口中 RawKVClientBase

scanPrefix

public List<Kvrpcpb.KvPair> scanPrefix(com.google.protobuf.ByteString prefixKey,
                                       boolean keyOnly)

指定者:

scanPrefix 在接口中 RawKVClientBase

delete

public void delete(com.google.protobuf.ByteString key)

从接口复制的说明: RawKVClientBase

Delete a raw key-value pair from TiKV if key exists

指定者:

delete 在接口中 RawKVClientBase

参数:

key - raw key to be deleted

deleteRange

public void deleteRange(com.google.protobuf.ByteString startKey,
                        com.google.protobuf.ByteString endKey)

从接口复制的说明: RawKVClientBase

Delete all raw key-value pairs in range [startKey, endKey) from TiKV

Cautious, this API cannot be used concurrently, if multiple clients write keys into this range along with deleteRange API, the result will be undefined.

指定者:

deleteRange 在接口中 RawKVClientBase

参数:

startKey - raw start key to be deleted

endKey - raw start key to be deleted

deletePrefix

public void deletePrefix(com.google.protobuf.ByteString key)

从接口复制的说明: RawKVClientBase

Delete all raw key-value pairs with the prefix `key` from TiKV

Cautious, this API cannot be used concurrently, if multiple clients write keys into this range along with deleteRange API, the result will be undefined.

指定者:

deletePrefix 在接口中 RawKVClientBase

参数:

key - prefix of keys to be deleted

getSession

public TiSession getSession()

从接口复制的说明: RawKVClientBase

Get the session of the current client

指定者:

getSession 在接口中 RawKVClientBase

ingest

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

Ingest KV pairs to RawKV using StreamKV API.

参数:

list -

ingest

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

Ingest KV pairs to RawKV using StreamKV API.

参数:

list -

ttl - the ttl of the key (in seconds), 0 means the key will never be outdated

抛出:

GrpcException

scan0

public Iterator<Kvrpcpb.KvPair> scan0(com.google.protobuf.ByteString startKey,
                                      com.google.protobuf.ByteString endKey,
                                      int limit)

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

参数:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

limit - limit of key-value pairs scanned, should be less than RawKVClientBase.MAX_RAW_SCAN_LIMIT

返回:

iterator of key-value pairs in range

scan0

public Iterator<Kvrpcpb.KvPair> scan0(com.google.protobuf.ByteString startKey,
                                      int limit)

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

参数:

startKey - raw start key, inclusive

limit - limit of key-value pairs scanned, should be less than RawKVClientBase.MAX_RAW_SCAN_LIMIT

返回:

iterator of key-value pairs in range

scan0

public Iterator<Kvrpcpb.KvPair> scan0(com.google.protobuf.ByteString startKey,
                                      int limit,
                                      boolean keyOnly)

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

参数:

startKey - raw start key, inclusive

limit - limit of key-value pairs scanned, should be less than RawKVClientBase.MAX_RAW_SCAN_LIMIT

keyOnly - whether to scan in key-only mode

返回:

iterator of key-value pairs in range

scan0

public Iterator<Kvrpcpb.KvPair> scan0(com.google.protobuf.ByteString startKey,
                                      com.google.protobuf.ByteString endKey,
                                      int limit,
                                      boolean keyOnly)

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

参数:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

limit - limit of key-value pairs scanned, should be less than RawKVClientBase.MAX_RAW_SCAN_LIMIT

keyOnly - whether to scan in key-only mode

返回:

iterator of key-value pairs in range

scan0

public Iterator<Kvrpcpb.KvPair> scan0(com.google.protobuf.ByteString startKey,
                                      com.google.protobuf.ByteString endKey)

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

参数:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

返回:

iterator of key-value pairs in range

scanPrefix0

public Iterator<Kvrpcpb.KvPair> scanPrefix0(com.google.protobuf.ByteString prefixKey,
                                            int limit,
                                            boolean keyOnly)

Scan keys with prefix

参数:

prefixKey - prefix key

limit - limit of keys retrieved

keyOnly - whether to scan in keyOnly mode

返回:

kvPairs iterator with the specified prefix

scanPrefix0

public Iterator<Kvrpcpb.KvPair> scanPrefix0(com.google.protobuf.ByteString prefixKey)

scanPrefix0

public Iterator<Kvrpcpb.KvPair> scanPrefix0(com.google.protobuf.ByteString prefixKey,
                                            boolean keyOnly)

scan0

public Iterator<Kvrpcpb.KvPair> scan0(com.google.protobuf.ByteString startKey,
                                      com.google.protobuf.ByteString endKey,
                                      boolean keyOnly)

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

参数:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

keyOnly - whether to scan in key-only mode

返回:

iterator of key-value pairs in range