me.ccute.kvstore.sdk.client.KvClient Interface Reference

Inheritance diagram for me.ccute.kvstore.sdk.client.KvClient:

Collaboration diagram for me.ccute.kvstore.sdk.client.KvClient:

Public Member Functions
void	set (String key, String value)
String	get (String key)
boolean	delete (String key)
void	increment (String key, int increment)
void	increment (String key)
String	execute (String command, String... args)
java.util.concurrent.CompletableFuture< String >	executeAsync (String command, String... args)

Detailed Description

The primary client for interacting with the kvstore database.

Implementations of this interface are completely thread-safe and are designed to be used across multiple threads in high-throughput applications. Users should instantiate this via KvClientBuilder.

Member Function Documentation

delete()

boolean me.ccute.kvstore.sdk.client.KvClient.delete

(

String

key

)

Deletes the given key and its associated value from the database.

Parameters

key	The unique identifier for the data. Cannot be null or empty.

Returns

true if the key was deleted, false if it did not exist.

Exceptions

KvException

if a network or server error occurs.

Implemented in me.ccute.kvstore.sdk.client.NettyKvClient.

execute()

String me.ccute.kvstore.sdk.client.KvClient.execute	(	String	command,
		String...	args )

Executes a raw command against the server. Useful for CLI tools or invoking custom server commands not yet typed in the SDK.

Parameters

command	The command to execute (e.g., "SET").
args	The arguments for the command.

Returns

The string response from the server.

Exceptions

KvException

if the command fails or times out.

Implemented in me.ccute.kvstore.sdk.client.NettyKvClient.

executeAsync()

java.util.concurrent.CompletableFuture< String > me.ccute.kvstore.sdk.client.KvClient.executeAsync	(	String	command,
		String...	args )

Executes a command asynchronously, returning a Future. Perfect for high-throughput pipelining.

Implemented in me.ccute.kvstore.sdk.client.NettyKvClient.

get()

String me.ccute.kvstore.sdk.client.KvClient.get

(

String

key

)

Retrieves the value associated with the given key.

Parameters

key	The unique identifier for the data. Cannot be null or empty.

Returns

The value, or null if the key does not exist.

Exceptions

KvException

if a network or server error occurs.

Implemented in me.ccute.kvstore.sdk.client.NettyKvClient.

increment() [1/2]

void me.ccute.kvstore.sdk.client.KvClient.increment

(

String

key

)

Increments the numeric value stored at the specified key by exactly 1.

This is a convenience method equivalent to calling increment(key, 1).

Parameters

key	The unique identifier for the data. Cannot be null or empty.

See also

#increment(String, int)

Implemented in me.ccute.kvstore.sdk.client.NettyKvClient.

increment() [2/2]

void me.ccute.kvstore.sdk.client.KvClient.increment	(	String	key,
		int	increment )

Increments the numeric value stored at the specified key by the given amount.

If the key does not exist, it is initialized to 0 before performing the increment. If the stored value cannot be parsed as an integer, a KvException is thrown.

Parameters

key	The unique identifier for the data. Cannot be null or empty.
increment	The amount to add to the current value. Can be negative to decrement.

Exceptions

IllegalArgumentException	if the key is invalid.
KvException	if a network error occurs or the existing value is not a number.

Implemented in me.ccute.kvstore.sdk.client.NettyKvClient.

set()

void me.ccute.kvstore.sdk.client.KvClient.set	(	String	key,
		String	value )

Stores a value in the database associated with the given key.

Parameters

key	The unique identifier for the data. Cannot be null or empty.
value	The string value to store. Cannot be null.

Exceptions

IllegalArgumentException	if the key or value is invalid.
KvException	if a network or server error occurs.

Implemented in me.ccute.kvstore.sdk.client.NettyKvClient.

---

The documentation for this interface was generated from the following file:

• sdk/java/src/main/java/me/ccute/kvstore/sdk/client/KvClient.java