Java: Add FLUSHDB command. (valkey-io#1593)

* Java: Add `FLUSHDB` command. (#366) Signed-off-by: Yury-Fridlyand <[email protected]>
Bit-Quill · Jun 19, 2024 · 16ba58d · 16ba58d
1 parent dd8724b
commit 16ba58d
Show file tree

Hide file tree

Showing 15 changed files with 391 additions and 15 deletions.
diff --git a/glide-core/src/protobuf/redis_request.proto b/glide-core/src/protobuf/redis_request.proto
@@ -203,6 +203,7 @@ enum RequestType {
     FunctionKill = 161;
     FunctionStats = 162;
     FCallReadOnly = 163;
+    FlushDB = 164;
     LSet = 165;
     XDel = 166;
     XRange = 167;

diff --git a/glide-core/src/request_type.rs b/glide-core/src/request_type.rs
@@ -173,6 +173,7 @@ pub enum RequestType {
     FunctionKill = 161,
     FunctionStats = 162,
     FCallReadOnly = 163,
+    FlushDB = 164,
     LSet = 165,
     XDel = 166,
     XRange = 167,
@@ -372,6 +373,7 @@ impl From<::protobuf::EnumOrUnknown<ProtobufRequestType>> for RequestType {
             ProtobufRequestType::FunctionKill => RequestType::FunctionKill,
             ProtobufRequestType::FunctionStats => RequestType::FunctionStats,
             ProtobufRequestType::FCallReadOnly => RequestType::FCallReadOnly,
+            ProtobufRequestType::FlushDB => RequestType::FlushDB,
             ProtobufRequestType::LSet => RequestType::LSet,
             ProtobufRequestType::XDel => RequestType::XDel,
             ProtobufRequestType::XRange => RequestType::XRange,
@@ -568,6 +570,7 @@ impl RequestType {
             RequestType::FunctionKill => Some(get_two_word_command("FUNCTION", "KILL")),
             RequestType::FunctionStats => Some(get_two_word_command("FUNCTION", "STATS")),
             RequestType::FCallReadOnly => Some(cmd("FCALL_RO")),
+            RequestType::FlushDB => Some(cmd("FLUSHDB")),
             RequestType::LSet => Some(cmd("LSET")),
             RequestType::XDel => Some(cmd("XDEL")),
             RequestType::XRange => Some(cmd("XRANGE")),

diff --git a/java/client/src/main/java/glide/api/RedisClient.java b/java/client/src/main/java/glide/api/RedisClient.java
@@ -18,6 +18,7 @@
 import static redis_request.RedisRequestOuterClass.RequestType.DBSize;
 import static redis_request.RedisRequestOuterClass.RequestType.Echo;
 import static redis_request.RedisRequestOuterClass.RequestType.FlushAll;
+import static redis_request.RedisRequestOuterClass.RequestType.FlushDB;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionDelete;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionFlush;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionKill;
@@ -175,6 +176,17 @@ public CompletableFuture<String> flushall(@NonNull FlushMode mode) {
                 FlushAll, new String[] {mode.toString()}, this::handleStringResponse);
     }
 
+    @Override
+    public CompletableFuture<String> flushdb() {
+        return commandManager.submitNewCommand(FlushDB, new String[0], this::handleStringResponse);
+    }
+
+    @Override
+    public CompletableFuture<String> flushdb(@NonNull FlushMode mode) {
+        return commandManager.submitNewCommand(
+                FlushDB, new String[] {mode.toString()}, this::handleStringResponse);
+    }
+
     @Override
     public CompletableFuture<String> lolwut() {
         return commandManager.submitNewCommand(Lolwut, new String[0], this::handleStringResponse);

diff --git a/java/client/src/main/java/glide/api/RedisClusterClient.java b/java/client/src/main/java/glide/api/RedisClusterClient.java
@@ -21,6 +21,7 @@
 import static redis_request.RedisRequestOuterClass.RequestType.FCall;
 import static redis_request.RedisRequestOuterClass.RequestType.FCallReadOnly;
 import static redis_request.RedisRequestOuterClass.RequestType.FlushAll;
+import static redis_request.RedisRequestOuterClass.RequestType.FlushDB;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionDelete;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionFlush;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionKill;
@@ -346,6 +347,30 @@ public CompletableFuture<String> flushall(
                 FlushAll, new String[] {mode.toString()}, route, this::handleStringResponse);
     }
 
+    @Override
+    public CompletableFuture<String> flushdb() {
+        return commandManager.submitNewCommand(FlushDB, new String[0], this::handleStringResponse);
+    }
+
+    @Override
+    public CompletableFuture<String> flushdb(@NonNull FlushMode mode) {
+        return commandManager.submitNewCommand(
+                FlushDB, new String[] {mode.toString()}, this::handleStringResponse);
+    }
+
+    @Override
+    public CompletableFuture<String> flushdb(@NonNull SingleNodeRoute route) {
+        return commandManager.submitNewCommand(
+                FlushDB, new String[0], route, this::handleStringResponse);
+    }
+
+    @Override
+    public CompletableFuture<String> flushdb(
+            @NonNull FlushMode mode, @NonNull SingleNodeRoute route) {
+        return commandManager.submitNewCommand(
+                FlushDB, new String[] {mode.toString()}, route, this::handleStringResponse);
+    }
+
     @Override
     public CompletableFuture<String> lolwut() {
         return commandManager.submitNewCommand(Lolwut, new String[0], this::handleStringResponse);

diff --git a/java/client/src/main/java/glide/api/commands/ServerManagementClusterCommands.java b/java/client/src/main/java/glide/api/commands/ServerManagementClusterCommands.java
@@ -353,7 +353,7 @@ public interface ServerManagementClusterCommands {
      *
      * @see <a href="https://valkey.io/commands/flushall/">valkey.io</a> for details.
      * @param route Specifies the routing configuration for the command. The client will route the
-     *     command to the nodes defined by <code>route</code>.
+     *     command to the node defined by <code>route</code>.
      * @return <code>OK</code>.
      * @example
      *     <pre>{@code
@@ -371,7 +371,7 @@ public interface ServerManagementClusterCommands {
      * @param mode The flushing mode, could be either {@link FlushMode#SYNC} or {@link
      *     FlushMode#ASYNC}.
      * @param route Specifies the routing configuration for the command. The client will route the
-     *     command to the nodes defined by <code>route</code>.
+     *     command to the node defined by <code>route</code>.
      * @return <code>OK</code>.
      * @example
      *     <pre>{@code
@@ -382,6 +382,70 @@ public interface ServerManagementClusterCommands {
      */
     CompletableFuture<String> flushall(FlushMode mode, SingleNodeRoute route);
 
+    /**
+     * Deletes all the keys of the currently selected database. This command never fails.<br>
+     * The command will be routed to all primary nodes.
+     *
+     * @see <a href="https://valkey.io/commands/flushdb/">valkey.io</a> for details.
+     * @return <code>OK</code>.
+     * @example
+     *     <pre>{@code
+     * String response = client.flushdb().get();
+     * assert response.equals("OK");
+     * }</pre>
+     */
+    CompletableFuture<String> flushdb();
+
+    /**
+     * Deletes all the keys of the currently selected database. This command never fails.<br>
+     * The command will be routed to all primary nodes.
+     *
+     * @see <a href="https://valkey.io/commands/flushdb/">valkey.io</a> for details.
+     * @param mode The flushing mode, could be either {@link FlushMode#SYNC} or {@link
+     *     FlushMode#ASYNC}.
+     * @return <code>OK</code>.
+     * @example
+     *     <pre>{@code
+     * String response = client.flushdb(ASYNC).get();
+     * assert response.equals("OK");
+     * }</pre>
+     */
+    CompletableFuture<String> flushdb(FlushMode mode);
+
+    /**
+     * Deletes all the keys of the currently selected database. This command never fails.
+     *
+     * @see <a href="https://valkey.io/commands/flushdb/">valkey.io</a> for details.
+     * @param route Specifies the routing configuration for the command. The client will route the
+     *     command to the node defined by <code>route</code>.
+     * @return <code>OK</code>.
+     * @example
+     *     <pre>{@code
+     * Route route = new SlotKeyRoute("key", PRIMARY);
+     * String response = client.flushdb(route).get();
+     * assert response.equals("OK");
+     * }</pre>
+     */
+    CompletableFuture<String> flushdb(SingleNodeRoute route);
+
+    /**
+     * Deletes all the keys of the currently selected database. This command never fails.
+     *
+     * @see <a href="https://valkey.io/commands/flushdb/">valkey.io</a> for details.
+     * @param mode The flushing mode, could be either {@link FlushMode#SYNC} or {@link
+     *     FlushMode#ASYNC}.
+     * @param route Specifies the routing configuration for the command. The client will route the
+     *     command to the node defined by <code>route</code>.
+     * @return <code>OK</code>.
+     * @example
+     *     <pre>{@code
+     * Route route = new SlotKeyRoute("key", PRIMARY);
+     * String response = client.flushdb(SYNC, route).get();
+     * assert response.equals("OK");
+     * }</pre>
+     */
+    CompletableFuture<String> flushdb(FlushMode mode, SingleNodeRoute route);
+
     /**
      * Displays a piece of generative computer art and the Redis version.<br>
      * The command will be routed to a random node.

diff --git a/java/client/src/main/java/glide/api/commands/ServerManagementCommands.java b/java/client/src/main/java/glide/api/commands/ServerManagementCommands.java
@@ -180,6 +180,34 @@ public interface ServerManagementCommands {
      */
     CompletableFuture<String> flushall(FlushMode mode);
 
+    /**
+     * Deletes all the keys of the currently selected database. This command never fails.
+     *
+     * @see <a href="https://valkey.io/commands/flushdb/">valkey.io</a> for details.
+     * @return <code>OK</code>.
+     * @example
+     *     <pre>{@code
+     * String response = client.flushdb().get();
+     * assert response.equals("OK");
+     * }</pre>
+     */
+    CompletableFuture<String> flushdb();
+
+    /**
+     * Deletes all the keys of the currently selected database. This command never fails.
+     *
+     * @see <a href="https://valkey.io/commands/flushdb/">valkey.io</a> for details.
+     * @param mode The flushing mode, could be either {@link FlushMode#SYNC} or {@link
+     *     FlushMode#ASYNC}.
+     * @return <code>OK</code>.
+     * @example
+     *     <pre>{@code
+     * String response = client.flushdb(ASYNC).get();
+     * assert response.equals("OK");
+     * }</pre>
+     */
+    CompletableFuture<String> flushdb(FlushMode mode);
+
     /**
      * Displays a piece of generative computer art and the Redis version.
      *

diff --git a/java/client/src/main/java/glide/api/models/BaseTransaction.java b/java/client/src/main/java/glide/api/models/BaseTransaction.java
@@ -53,6 +53,7 @@
 import static redis_request.RedisRequestOuterClass.RequestType.FCall;
 import static redis_request.RedisRequestOuterClass.RequestType.FCallReadOnly;
 import static redis_request.RedisRequestOuterClass.RequestType.FlushAll;
+import static redis_request.RedisRequestOuterClass.RequestType.FlushDB;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionDelete;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionFlush;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionList;
@@ -3122,6 +3123,30 @@ public T flushall(FlushMode mode) {
         return getThis();
     }
 
+    /**
+     * Deletes all the keys of the currently selected database. This command never fails.
+     *
+     * @see <a href="https://valkey.io/commands/flushdb/">valkey.io</a> for details.
+     * @return Command Response - <code>OK</code>.
+     */
+    public T flushdb() {
+        protobufTransaction.addCommands(buildCommand(FlushDB));
+        return getThis();
+    }
+
+    /**
+     * Deletes all the keys of the currently selected database. This command never fails.
+     *
+     * @see <a href="https://valkey.io/commands/flushdb/">valkey.io</a> for details.
+     * @param mode The flushing mode, could be either {@link FlushMode#SYNC} or {@link
+     *     FlushMode#ASYNC}.
+     * @return Command Response - <code>OK</code>.
+     */
+    public T flushdb(FlushMode mode) {
+        protobufTransaction.addCommands(buildCommand(FlushDB, buildArgs(mode.toString())));
+        return getThis();
+    }
+
     /**
      * Displays a piece of generative computer art and the Redis version.
      *

diff --git a/java/client/src/main/java/glide/api/models/commands/FlushMode.java b/java/client/src/main/java/glide/api/models/commands/FlushMode.java
@@ -14,16 +14,24 @@
  *   <li><code>FLUSHALL</code> command implemented by {@link RedisClient#flushall(FlushMode)},
  *       {@link RedisClusterClient#flushall(FlushMode)}, and {@link
  *       RedisClusterClient#flushall(FlushMode, SingleNodeRoute)}.
+ *   <li><code>FLUSHDB</code> command implemented by {@link RedisClient#flushdb(FlushMode)}, {@link
+ *       RedisClusterClient#flushdb(FlushMode)}, and {@link RedisClusterClient#flushdb(FlushMode,
+ *       SingleNodeRoute)}.
  *   <li><code>FUNCTION FLUSH</code> command implemented by {@link
  *       RedisClient#functionFlush(FlushMode)}, {@link RedisClusterClient#functionFlush(FlushMode)},
  *       and {@link RedisClusterClient#functionFlush(FlushMode, Route)}.
  * </ul>
  *
- * @see <a href="https://valkey.io/commands/flushall/">valkey.io</a> and <a
- *     href="https://valkey.io/commands/function-flush/">valkey.io</a>
+ * @see <a href="https://valkey.io/commands/flushall/">flushall</a>, <a
+ *     href="https://valkey.io/commands/flushdb/">flushdb</a>, and <a
+ *     href="https://valkey.io/commands/function-flush/">function flush</a> at valkey.io
  */
 public enum FlushMode {
-    /** Flushes synchronously. */
+    /**
+     * Flushes synchronously.
+     *
+     * @since Redis 6.2 and above.
+     */
     SYNC,
     /** Flushes asynchronously. */
     ASYNC

diff --git a/java/client/src/main/java/glide/api/models/configuration/RequestRoutingConfiguration.java b/java/client/src/main/java/glide/api/models/configuration/RequestRoutingConfiguration.java
@@ -31,7 +31,12 @@ public interface MultiNodeRoute extends Route {}
     @RequiredArgsConstructor
     @Getter
     public enum SimpleSingleNodeRoute implements SingleNodeRoute {
-        /** Route request to a random node. */
+        /**
+         * Route request to a random node.<br>
+         * <b>Warning</b><br>
+         * Don't use it with write commands, because they could be randomly routed to a replica (RO)
+         * node and fail.
+         */
         RANDOM(2);
 
         private final int ordinal;
@@ -40,7 +45,10 @@ public enum SimpleSingleNodeRoute implements SingleNodeRoute {
     @RequiredArgsConstructor
     @Getter
     public enum SimpleMultiNodeRoute implements MultiNodeRoute {
-        /** Route request to all nodes. */
+        /**
+         * Route request to all nodes. <b>Warning</b><br>
+         * Don't use it with write commands, they could be routed to a replica (RO) node and fail.
+         */
         ALL_NODES(0),
         /** Route request to all primary nodes. */
         ALL_PRIMARIES(1);

diff --git a/java/client/src/test/java/glide/api/RedisClientTest.java b/java/client/src/test/java/glide/api/RedisClientTest.java
@@ -87,6 +87,7 @@
 import static redis_request.RedisRequestOuterClass.RequestType.FCall;
 import static redis_request.RedisRequestOuterClass.RequestType.FCallReadOnly;
 import static redis_request.RedisRequestOuterClass.RequestType.FlushAll;
+import static redis_request.RedisRequestOuterClass.RequestType.FlushDB;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionDelete;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionFlush;
 import static redis_request.RedisRequestOuterClass.RequestType.FunctionKill;
@@ -4647,6 +4648,47 @@ public void flushall_with_mode_returns_success() {
         assertEquals(OK, payload);
     }
 
+    @SneakyThrows
+    @Test
+    public void flushdb_returns_success() {
+        // setup
+        CompletableFuture<String> testResponse = new CompletableFuture<>();
+        testResponse.complete(OK);
+
+        // match on protobuf request
+        when(commandManager.<String>submitNewCommand(eq(FlushDB), eq(new String[0]), any()))
+                .thenReturn(testResponse);
+
+        // exercise
+        CompletableFuture<String> response = service.flushdb();
+        String payload = response.get();
+
+        // verify
+        assertEquals(testResponse, response);
+        assertEquals(OK, payload);
+    }
+
+    @SneakyThrows
+    @Test
+    public void flushdb_with_mode_returns_success() {
+        // setup
+        CompletableFuture<String> testResponse = new CompletableFuture<>();
+        testResponse.complete(OK);
+
+        // match on protobuf request
+        when(commandManager.<String>submitNewCommand(
+                        eq(FlushDB), eq(new String[] {SYNC.toString()}), any()))
+                .thenReturn(testResponse);
+
+        // exercise
+        CompletableFuture<String> response = service.flushdb(SYNC);
+        String payload = response.get();
+
+        // verify
+        assertEquals(testResponse, response);
+        assertEquals(OK, payload);
+    }
+
     @SneakyThrows
     @Test
     public void lolwut_returns_success() {