forked from valkey-io/valkey-glide
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Java: Add transaction commands (valkey-io#895)
* Java: Add transaction commands Signed-off-by: Andrew Carbonetto <[email protected]> * Clean up for review comments Signed-off-by: Andrew Carbonetto <[email protected]> * Fix CommandManagerTest.java Signed-off-by: Andrew Carbonetto <[email protected]> * All transactions require an argument (empty is fine) Signed-off-by: Andrew Carbonetto <[email protected]> * Add IT tests for transactions Signed-off-by: Andrew Carbonetto <[email protected]> * Renaming field Signed-off-by: Andrew Carbonetto <[email protected]> * Add IT tests for Transactions Signed-off-by: Andrew Carbonetto <[email protected]> * Update exec() command with route Signed-off-by: Andrew Carbonetto <[email protected]> * Update exec() command with route Signed-off-by: Andrew Carbonetto <[email protected]> * Remove failing tests Signed-off-by: Andrew Carbonetto <[email protected]> * Spotless Signed-off-by: Andrew Carbonetto <[email protected]> * Spotless Signed-off-by: Andrew Carbonetto <[email protected]> * Spotless Signed-off-by: Andrew Carbonetto <[email protected]> * Update cluster comments Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]> Signed-off-by: Andrew Carbonetto <[email protected]>
- Loading branch information
1 parent
e6a0de5
commit 8823a1a
Showing
15 changed files
with
830 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
188 changes: 188 additions & 0 deletions
188
java/client/src/main/java/glide/api/models/BaseTransaction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| /** Copyright GLIDE-for-Redis Project Contributors - SPDX Identifier: Apache-2.0 */ | ||
| package glide.api.models; | ||
|
|
||
| import static redis_request.RedisRequestOuterClass.RequestType.CustomCommand; | ||
| import static redis_request.RedisRequestOuterClass.RequestType.GetString; | ||
| import static redis_request.RedisRequestOuterClass.RequestType.Info; | ||
| import static redis_request.RedisRequestOuterClass.RequestType.Ping; | ||
| import static redis_request.RedisRequestOuterClass.RequestType.SetString; | ||
|
|
||
| import glide.api.models.commands.InfoOptions; | ||
| import glide.api.models.commands.InfoOptions.Section; | ||
| import glide.api.models.commands.SetOptions; | ||
| import glide.api.models.commands.SetOptions.ConditionalSet; | ||
| import glide.api.models.commands.SetOptions.SetOptionsBuilder; | ||
| import lombok.Getter; | ||
| import org.apache.commons.lang3.ArrayUtils; | ||
| import redis_request.RedisRequestOuterClass.Command; | ||
| import redis_request.RedisRequestOuterClass.Command.ArgsArray; | ||
| import redis_request.RedisRequestOuterClass.RequestType; | ||
| import redis_request.RedisRequestOuterClass.Transaction; | ||
|
|
||
| /** | ||
| * Base class encompassing shared commands for both standalone and cluster mode implementations in a | ||
| * transaction. Transactions allow the execution of a group of commands in a single step. | ||
| * | ||
| * <p>Command Response: An array of command responses is returned by the client exec command, in the | ||
| * order they were given. Each element in the array represents a command given to the transaction. | ||
| * The response for each command depends on the executed Redis command. Specific response types are | ||
| * documented alongside each method. | ||
| * | ||
| * @param <T> child typing for chaining method calls | ||
| */ | ||
| @Getter | ||
| public abstract class BaseTransaction<T extends BaseTransaction<T>> { | ||
| /** Command class to send a single request to Redis. */ | ||
| protected final Transaction.Builder protobufTransaction = Transaction.newBuilder(); | ||
|
|
||
| protected abstract T getThis(); | ||
|
|
||
| /** | ||
| * Executes a single command, without checking inputs. Every part of the command, including | ||
| * subcommands, should be added as a separate value in args. | ||
| * | ||
| * @remarks This function should only be used for single-response commands. Commands that don't | ||
| * return response (such as <em>SUBSCRIBE</em>), or that return potentially more than a single | ||
| * response (such as <em>XREAD</em>), or that change the client's behavior (such as entering | ||
| * <em>pub</em>/<em>sub</em> mode on <em>RESP2</em> connections) shouldn't be called using | ||
| * this function. | ||
| * @example Returns a list of all pub/sub clients: | ||
| * <pre> | ||
| * Object result = client.customCommand("CLIENT","LIST","TYPE", "PUBSUB").get(); | ||
| * </pre> | ||
| * | ||
| * @param args Arguments for the custom command. | ||
| * @return A response from Redis with an <code>Object</code>. | ||
| */ | ||
| public T customCommand(String... args) { | ||
|
|
||
| ArgsArray commandArgs = buildArgs(args); | ||
| protobufTransaction.addCommands(buildCommand(CustomCommand, commandArgs)); | ||
| return getThis(); | ||
| } | ||
|
|
||
| /** | ||
| * Ping the Redis server. | ||
| * | ||
| * @see <a href="https://redis.io/commands/ping/">redis.io</a> for details. | ||
| * @return A response from Redis with a <code>String</code>. | ||
| */ | ||
| public T ping() { | ||
| protobufTransaction.addCommands(buildCommand(Ping)); | ||
| return getThis(); | ||
| } | ||
|
|
||
| /** | ||
| * Ping the Redis server. | ||
| * | ||
| * @see <a href="https://redis.io/commands/ping/">redis.io</a> for details. | ||
| * @param msg The ping argument that will be returned. | ||
| * @return A response from Redis with a <code>String</code>. | ||
| */ | ||
| public T ping(String msg) { | ||
| ArgsArray commandArgs = buildArgs(msg); | ||
|
|
||
| protobufTransaction.addCommands(buildCommand(Ping, commandArgs)); | ||
| return getThis(); | ||
| } | ||
|
|
||
| /** | ||
| * Get information and statistics about the Redis server. No argument is provided, so the {@link | ||
| * Section#DEFAULT} option is assumed. | ||
| * | ||
| * @see <a href="https://redis.io/commands/info/">redis.io</a> for details. | ||
| * @return A response from Redis with a <code>String</code>. | ||
| */ | ||
| public T info() { | ||
| protobufTransaction.addCommands(buildCommand(Info)); | ||
| return getThis(); | ||
| } | ||
|
|
||
| /** | ||
| * Get information and statistics about the Redis server. | ||
| * | ||
| * @see <a href="https://redis.io/commands/info/">redis.io</a> for details. | ||
| * @param options A list of {@link Section} values specifying which sections of information to | ||
| * retrieve. When no parameter is provided, the {@link Section#DEFAULT} option is assumed. | ||
| * @return Response from Redis with a <code>String</code> containing the requested {@link | ||
| * Section}s. | ||
| */ | ||
| public T info(InfoOptions options) { | ||
| ArgsArray commandArgs = buildArgs(options.toArgs()); | ||
|
|
||
| protobufTransaction.addCommands(buildCommand(Info, commandArgs)); | ||
| return getThis(); | ||
| } | ||
|
|
||
| /** | ||
| * Get the value associated with the given key, or null if no such value exists. | ||
| * | ||
| * @see <a href="https://redis.io/commands/get/">redis.io</a> for details. | ||
| * @param key The key to retrieve from the database. | ||
| * @return Response from Redis. <code>key</code> exists, returns the <code>value</code> of <code> | ||
| * key</code> as a String. Otherwise, return <code>null</code>. | ||
| */ | ||
| public T get(String key) { | ||
| ArgsArray commandArgs = buildArgs(key); | ||
|
|
||
| protobufTransaction.addCommands(buildCommand(GetString, commandArgs)); | ||
| return getThis(); | ||
| } | ||
|
|
||
| /** | ||
| * Set the given key with the given value. | ||
| * | ||
| * @see <a href="https://redis.io/commands/set/">redis.io</a> for details. | ||
| * @param key The key to store. | ||
| * @param value The value to store with the given <code>key</code>. | ||
| * @return Response from Redis. | ||
| */ | ||
| public T set(String key, String value) { | ||
| ArgsArray commandArgs = buildArgs(key, value); | ||
|
|
||
| protobufTransaction.addCommands(buildCommand(SetString, commandArgs)); | ||
| return getThis(); | ||
| } | ||
|
|
||
| /** | ||
| * Set the given key with the given value. Return value is dependent on the passed options. | ||
| * | ||
| * @see <a href="https://redis.io/commands/set/">redis.io</a> for details. | ||
| * @param key The key to store. | ||
| * @param value The value to store with the given key. | ||
| * @param options The Set options. | ||
| * @return Response from Redis with a <code>String</code> or <code>null</code> response. The old | ||
| * value as a <code>String</code> if {@link SetOptionsBuilder#returnOldValue(boolean)} is set. | ||
| * Otherwise, if the value isn't set because of {@link ConditionalSet#ONLY_IF_EXISTS} or | ||
| * {@link ConditionalSet#ONLY_IF_DOES_NOT_EXIST} conditions, return <code>null</code>. | ||
| * Otherwise, return <code>OK</code>. | ||
| */ | ||
| public T set(String key, String value, SetOptions options) { | ||
| ArgsArray commandArgs = | ||
| buildArgs(ArrayUtils.addAll(new String[] {key, value}, options.toArgs())); | ||
|
|
||
| protobufTransaction.addCommands(buildCommand(SetString, commandArgs)); | ||
| return getThis(); | ||
| } | ||
|
|
||
| /** Build protobuf {@link Command} object for given command and arguments. */ | ||
| protected Command buildCommand(RequestType requestType) { | ||
| return buildCommand(requestType, buildArgs()); | ||
| } | ||
|
|
||
| /** Build protobuf {@link Command} object for given command and arguments. */ | ||
| protected Command buildCommand(RequestType requestType, ArgsArray args) { | ||
| return Command.newBuilder().setRequestType(requestType).setArgsArray(args).build(); | ||
| } | ||
|
|
||
| /** Build protobuf {@link ArgsArray} object for given arguments. */ | ||
| protected ArgsArray buildArgs(String... stringArgs) { | ||
| ArgsArray.Builder commandArgs = ArgsArray.newBuilder(); | ||
|
|
||
| for (String string : stringArgs) { | ||
| commandArgs.addArgs(string); | ||
| } | ||
|
|
||
| return commandArgs.build(); | ||
| } | ||
| } |
30 changes: 30 additions & 0 deletions
30
java/client/src/main/java/glide/api/models/ClusterTransaction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| /** Copyright GLIDE-for-Redis Project Contributors - SPDX Identifier: Apache-2.0 */ | ||
| package glide.api.models; | ||
|
|
||
| import lombok.AllArgsConstructor; | ||
|
|
||
| /** | ||
| * Extends BaseTransaction class for cluster mode commands. Transactions allow the execution of a | ||
| * group of commands in a single step. | ||
| * | ||
| * <p>Command Response: An array of command responses is returned by the client <code>exec</code> | ||
| * command, in the order they were given. Each element in the array represents a command given to | ||
| * the <code>Transaction</code>. The response for each command depends on the executed Redis | ||
| * command. Specific response types are documented alongside each method. | ||
| * | ||
| * @example | ||
| * <pre> | ||
| * ClusterTransaction transaction = new ClusterTransaction(); | ||
| * .set("key", "value"); | ||
| * .get("key"); | ||
| * ClusterValue[] result = client.exec(transaction, route).get(); | ||
| * // result contains: OK and "value" | ||
| * </pre> | ||
| */ | ||
| @AllArgsConstructor | ||
| public class ClusterTransaction extends BaseTransaction<ClusterTransaction> { | ||
| @Override | ||
| protected ClusterTransaction getThis() { | ||
| return this; | ||
| } | ||
| } |
Oops, something went wrong.