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 XADD command (Stream commands) (valkey-io#1209)
* Java: Add XADD command (Stream commands) (#155) Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: SanHalacogluImproving <[email protected]>
- Loading branch information
Showing
8 changed files
with
598 additions
and
10 deletions.
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
51 changes: 51 additions & 0 deletions
51
java/client/src/main/java/glide/api/commands/StreamBaseCommands.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,51 @@ | ||
| /** Copyright GLIDE-for-Redis Project Contributors - SPDX Identifier: Apache-2.0 */ | ||
| package glide.api.commands; | ||
|
|
||
| import glide.api.models.commands.StreamAddOptions; | ||
| import java.util.Map; | ||
| import java.util.concurrent.CompletableFuture; | ||
|
|
||
| /** | ||
| * Supports commands and transactions for the "Stream Commands" group for standalone and cluster | ||
| * clients. | ||
| * | ||
| * @see <a href="https://redis.io/commands/?group=stream">Stream Commands</a> | ||
| */ | ||
| public interface StreamBaseCommands { | ||
|
|
||
| /** | ||
| * Adds an entry to the specified stream. | ||
| * | ||
| * @see <a href="https://redis.io/commands/xadd/">redis.io</a> for details. | ||
| * @param key The key of the stream. | ||
| * @param values Field-value pairs to be added to the entry. | ||
| * @return The id of the added entry. | ||
| * @example | ||
| * <pre>{@code | ||
| * String streamId = client.xadd("key", Map.of("name", "Sara", "surname", "OConnor").get(); | ||
| * System.out.println("Stream: " + streamId); | ||
| * }</pre> | ||
| */ | ||
| CompletableFuture<String> xadd(String key, Map<String, String> values); | ||
|
|
||
| /** | ||
| * Adds an entry to the specified stream. | ||
| * | ||
| * @see <a href="https://redis.io/commands/xadd/">redis.io</a> for details. | ||
| * @param key The key of the stream. | ||
| * @param values Field-value pairs to be added to the entry. | ||
| * @param options Stream add options. | ||
| * @return The id of the added entry, or <code>null</code> if {@link StreamAddOptions#makeStream} | ||
| * is set to <code>false</code> and no stream with the matching <code>key</code> exists. | ||
| * @example | ||
| * <pre>{@code | ||
| * // Option to use the existing stream, or return null if the stream doesn't already exist at "key" | ||
| * StreamAddOptions options = StreamAddOptions.builder().id("sid").makeStream(Boolean.FALSE).build(); | ||
| * String streamId = client.xadd("key", Map.of("name", "Sara", "surname", "OConnor"), options).get(); | ||
| * if (streamId != null) { | ||
| * assert streamId.equals("sid"); | ||
| * } | ||
| * }</pre> | ||
| */ | ||
| CompletableFuture<String> xadd(String key, Map<String, String> values, StreamAddOptions options); | ||
| } |
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
177 changes: 177 additions & 0 deletions
177
java/client/src/main/java/glide/api/models/commands/StreamAddOptions.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,177 @@ | ||
| /** Copyright GLIDE-for-Redis Project Contributors - SPDX Identifier: Apache-2.0 */ | ||
| package glide.api.models.commands; | ||
|
|
||
| import glide.api.commands.StreamBaseCommands; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import lombok.Builder; | ||
| import lombok.NonNull; | ||
|
|
||
| /** | ||
| * Optional arguments to {@link StreamBaseCommands#xadd} | ||
| * | ||
| * @see <a href="https://redis.io/commands/xadd/">redis.io</a> | ||
| */ | ||
| @Builder | ||
| public final class StreamAddOptions { | ||
|
|
||
| public static final String NO_MAKE_STREAM_REDIS_API = "NOMKSTREAM"; | ||
| public static final String ID_WILDCARD_REDIS_API = "*"; | ||
| public static final String TRIM_MAXLEN_REDIS_API = "MAXLEN"; | ||
| public static final String TRIM_MINID_REDIS_API = "MINID"; | ||
| public static final String TRIM_EXACT_REDIS_API = "="; | ||
| public static final String TRIM_NOT_EXACT_REDIS_API = "~"; | ||
| public static final String TRIM_LIMIT_REDIS_API = "LIMIT"; | ||
|
|
||
| /** If set, the new entry will be added with this <code>id</code>. */ | ||
| private final String id; | ||
|
|
||
| /** | ||
| * If set to <code>false</code>, a new stream won't be created if no stream matches the given key. | ||
| * <br> | ||
| * Equivalent to <code>NOMKSTREAM</code> in the Redis API. | ||
| */ | ||
| private final Boolean makeStream; | ||
|
|
||
| /** If set, the add operation will also trim the older entries in the stream. */ | ||
| private final StreamTrimOptions trim; | ||
|
|
||
| public abstract static class StreamTrimOptions { | ||
| /** | ||
| * If <code>true</code>, the stream will be trimmed exactly. Equivalent to <code>=</code> in the | ||
| * Redis API. Otherwise, the stream will be trimmed in a near-exact manner, which is more | ||
| * efficient, equivalent to <code>~</code> in the Redis API. | ||
| */ | ||
| protected boolean exact; | ||
|
|
||
| /** If set, sets the maximal amount of entries that will be deleted. */ | ||
| protected Long limit; | ||
|
|
||
| protected abstract String getMethod(); | ||
|
|
||
| protected abstract String getThreshold(); | ||
|
|
||
| protected List<String> getRedisApi() { | ||
| List<String> optionArgs = new ArrayList<>(); | ||
|
|
||
| optionArgs.add(this.getMethod()); | ||
| optionArgs.add(this.exact ? TRIM_EXACT_REDIS_API : TRIM_NOT_EXACT_REDIS_API); | ||
| optionArgs.add(this.getThreshold()); | ||
|
|
||
| if (this.limit != null) { | ||
| optionArgs.add(TRIM_LIMIT_REDIS_API); | ||
| optionArgs.add(this.limit.toString()); | ||
| } | ||
|
|
||
| return optionArgs; | ||
| } | ||
| } | ||
|
|
||
| /** Option to trim the stream according to minimum ID. */ | ||
| public static class MinId extends StreamTrimOptions { | ||
| /** Trim the stream according to entry ID. Equivalent to <code>MINID</code> in the Redis API. */ | ||
| private final String threshold; | ||
|
|
||
| /** | ||
| * Create a trim option to trim stream based on stream ID. | ||
| * | ||
| * @param exact Whether to match exactly on the threshold. | ||
| * @param threshold Comparison id. | ||
| */ | ||
| public MinId(boolean exact, @NonNull String threshold) { | ||
| this.threshold = threshold; | ||
| this.exact = exact; | ||
| } | ||
|
|
||
| /** | ||
| * Create a trim option to trim stream based on stream ID. | ||
| * | ||
| * @param exact Whether to match exactly on the threshold. | ||
| * @param threshold Comparison id. | ||
| * @param limit Max number of stream entries to be trimmed. | ||
| */ | ||
| public MinId(boolean exact, @NonNull String threshold, long limit) { | ||
| this.threshold = threshold; | ||
| this.exact = exact; | ||
| this.limit = limit; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getMethod() { | ||
| return TRIM_MINID_REDIS_API; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getThreshold() { | ||
| return threshold; | ||
| } | ||
| } | ||
|
|
||
| /** Option to trim the stream according to maximum stream length. */ | ||
| public static class MaxLen extends StreamTrimOptions { | ||
| /** | ||
| * Trim the stream according to length.<br> | ||
| * Equivalent to <code>MAXLEN</code> in the Redis API. | ||
| */ | ||
| private final Long threshold; | ||
|
|
||
| /** | ||
| * Create a Max Length trim option to trim stream based on length. | ||
| * | ||
| * @param exact Whether to match exactly on the threshold. | ||
| * @param threshold Comparison count. | ||
| */ | ||
| public MaxLen(boolean exact, long threshold) { | ||
| this.threshold = threshold; | ||
| this.exact = exact; | ||
| } | ||
|
|
||
| /** | ||
| * Create a Max Length trim option to trim stream entries exceeds the threshold. | ||
| * | ||
| * @param exact Whether to match exactly on the threshold. | ||
| * @param threshold Comparison count. | ||
| * @param limit Max number of stream entries to be trimmed. | ||
| */ | ||
| public MaxLen(boolean exact, long threshold, long limit) { | ||
| this.threshold = threshold; | ||
| this.exact = exact; | ||
| this.limit = limit; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getMethod() { | ||
| return TRIM_MAXLEN_REDIS_API; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getThreshold() { | ||
| return threshold.toString(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Converts options for Xadd into a String[]. | ||
| * | ||
| * @return String[] | ||
| */ | ||
| public String[] toArgs() { | ||
| List<String> optionArgs = new ArrayList<>(); | ||
|
|
||
| if (makeStream != null && !makeStream) { | ||
| optionArgs.add(NO_MAKE_STREAM_REDIS_API); | ||
| } | ||
|
|
||
| if (trim != null) { | ||
| optionArgs.addAll(trim.getRedisApi()); | ||
| } | ||
|
|
||
| if (id != null) { | ||
| optionArgs.add(id); | ||
| } else { | ||
| optionArgs.add(ID_WILDCARD_REDIS_API); | ||
| } | ||
|
|
||
| return optionArgs.toArray(new String[0]); | ||
| } | ||
| } |
Oops, something went wrong.