org.tikv.raw

Interface RawKVClientBase

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RawKVClient, SmartRawKVClient

public interface RawKVClientBase
extends AutoCloseable

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RAW_BATCH_LIMIT
static int	MAX_RAW_SCAN_LIMIT
static int	RAW_BATCH_DELETE_SIZE
static int	RAW_BATCH_GET_SIZE
static int	RAW_BATCH_PUT_SIZE

Method Summary

Modifier and Type	Method and Description
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	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
void	deleteRange(com.google.protobuf.ByteString startKey, com.google.protobuf.ByteString endKey) Delete all raw key-value pairs in range [startKey, endKey) from TiKV
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	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, ♾)
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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

MAX_RAW_SCAN_LIMIT

static final int MAX_RAW_SCAN_LIMIT

See Also:

Constant Field Values

MAX_RAW_BATCH_LIMIT

static final int MAX_RAW_BATCH_LIMIT

See Also:

Constant Field Values

RAW_BATCH_PUT_SIZE

static final int RAW_BATCH_PUT_SIZE

See Also:

Constant Field Values

RAW_BATCH_GET_SIZE

static final int RAW_BATCH_GET_SIZE

See Also:

Constant Field Values

RAW_BATCH_DELETE_SIZE

static final int RAW_BATCH_DELETE_SIZE

See Also:

Constant Field Values

Method Detail

put

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

Put a raw key-value pair to TiKV

Parameters:

key - raw key

value - raw value

put

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

Put a raw key-value pair to TiKV

Parameters:

key - raw key

value - raw value

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

putIfAbsent

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. This API is atomic.

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

Parameters:

key - key

value - value

Returns:

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

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. This API is atomic.

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

Parameters:

key - key

value - value

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

Returns:

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

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. This API is atomic.

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

Parameters:

key - key

value - value

compareAndSet

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. This API is atomic.

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

Parameters:

key - key

value - value

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

batchPut

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

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

Parameters:

kvPairs - kvPairs

batchPut

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

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

Parameters:

kvPairs - kvPairs

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

get

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

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

Parameters:

key - raw key

Returns:

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

batchGet

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

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

Parameters:

keys - list of raw key

Returns:

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

batchDelete

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

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

Parameters:

keys - list of raw key

getKeyTTL

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

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

Parameters:

key - raw key

Returns:

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

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.

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.

Parameters:

ranges - a list of ranges

Returns:

a set of scanners for keys over the given keys.

batchScan

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

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.

Parameters:

ranges - a list of `ScanOption` for each range

Returns:

a set of scanners over the given keys.

scan

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)

Parameters:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

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

Returns:

list of key-value pairs in range

scan

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)

Parameters:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

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

keyOnly - whether to scan in key-only mode

Returns:

list of key-value pairs in range

scan

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

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

Parameters:

startKey - raw start key, inclusive

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

Returns:

list of key-value pairs in range

scan

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

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

Parameters:

startKey - raw start key, inclusive

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

keyOnly - whether to scan in key-only mode

Returns:

list of key-value pairs in range

scan

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)

Parameters:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

Returns:

list of key-value pairs in range

scan

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)

Parameters:

startKey - raw start key, inclusive

endKey - raw end key, exclusive

keyOnly - whether to scan in key-only mode

Returns:

list of key-value pairs in range

scanPrefix

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

Scan keys with prefix

Parameters:

prefixKey - prefix key

limit - limit of keys retrieved

keyOnly - whether to scan in keyOnly mode

Returns:

kvPairs with the specified prefix

scanPrefix

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

scanPrefix

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

delete

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

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

Parameters:

key - raw key to be deleted

deleteRange

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.

Parameters:

startKey - raw start key to be deleted

endKey - raw start key to be deleted

deletePrefix

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.

Parameters:

key - prefix of keys to be deleted

getSession

TiSession getSession()

Get the session of the current client