Introduce HGETDEL command to the Spring Data Redis framework

Signed-off-by: viktoriya.kutsarova <viktoriya.kutsarova@redis.com>

Author: viktoriya-kutsarova

Makefile

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-VERSION?=7.4.0
+VERSION?=8.0.0
 PROJECT?=redis
 GH_ORG?=redis
 SPRING_PROFILE?=ci

src/main/java/org/springframework/data/redis/connection/DefaultStringRedisConnection.java

@@ -23,6 +23,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jetbrains.annotations.NotNull;
 import org.jspecify.annotations.NullUnmarked;
 import org.jspecify.annotations.Nullable;
 import org.springframework.core.convert.converter.Converter;
@@ -1609,6 +1610,11 @@ public List<String> hVals(String key) {
 return convertAndReturn(delegate.hVals(serialize(key)), byteListToStringList);
 }
 
+ @Override
+ public List<String> hGetDel(String key, String... fields) {
+ return convertAndReturn(delegate.hGetDel(serialize(key), serializeMulti(fields)), byteListToStringList);
+ }
+
 @Override
 public Long incr(String key) {
 return incr(serialize(key));
@@ -2582,6 +2588,11 @@ public List<Long> hTtl(byte[] key, TimeUnit timeUnit, byte[]... fields) {
 return this.delegate.hTtl(key, timeUnit, fields);
 }
 
+ @Override
+ public List<byte[]> hGetDel(@NotNull byte[] key, @NotNull byte[]... fields) {
+ return convertAndReturn(delegate.hGetDel(key, fields), Converters.identityConverter());
+ }
+
 public @Nullable List<Long> applyExpiration(String key,
 org.springframework.data.redis.core.types.Expiration expiration,
 ExpirationOptions options, String... fields) {

src/main/java/org/springframework/data/redis/connection/DefaultedRedisConnection.java

@@ -1594,6 +1594,13 @@ default List<Long> hpTtl(byte[] key, byte[]... fields) {
 return hashCommands().hpTtl(key, fields);
 }
 
+ /** @deprecated in favor of {@link RedisConnection#hashCommands()}}. */
+ @Override
+ @Deprecated
+ default List<byte[]> hGetDel(byte[] key, byte[]... fields) {
+ return hashCommands().hGetDel(key, fields);
+ }
+
 /** @deprecated in favor of {@link RedisConnection#hashCommands()}}. */
 @Override
 @Deprecated

src/main/java/org/springframework/data/redis/connection/ReactiveHashCommands.java

@@ -58,6 +58,7 @@ public interface ReactiveHashCommands {
  *
  * @author Christoph Strobl
  * @author Tihomir Mateev
+ * @author Viktoriya Kutsarova
  */
 class HashFieldsCommand extends KeyCommand {
 
@@ -1255,4 +1256,86 @@ default Flux<Long> hpTtl(ByteBuffer key, List<ByteBuffer> fields) {
  */
 Flux<NumericResponse<HashFieldsCommand, Long>> hpTtl(Publisher<HashFieldsCommand> commands);
 
+
+ /**
+ * {@literal HGETDEL} {@link Command}.
+ *
+ * @author Viktoriya Kutsarova
+ * @see <a href="https://redis.io/commands/hgetdel">Redis Documentation: HGETDEL</a>
+ */
+ class HGetDelCommand extends HashFieldsCommand {
+
+ private HGetDelCommand(@Nullable ByteBuffer key, List<ByteBuffer> fields) {
+ super(key, fields);
+ }
+
+ /**
+ * Creates a new {@link HGetDelCommand} given a {@link ByteBuffer field name}.
+ *
+ * @param field must not be {@literal null}.
+ * @return a new {@link HGetDelCommand} for a {@link ByteBuffer field name}.
+ */
+ public static HGetDelCommand field(ByteBuffer field) {
+
+ Assert.notNull(field, "Field must not be null");
+
+ return new HGetDelCommand(null, Collections.singletonList(field));
+ }
+
+ /**
+ * Creates a new {@link HGetDelCommand} given a {@link Collection} of field names.
+ *
+ * @param fields must not be {@literal null}.
+ * @return a new {@link HGetDelCommand} for a {@link Collection} of field names.
+ */
+ public static HGetDelCommand fields(Collection<ByteBuffer> fields) {
+
+ Assert.notNull(fields, "Fields must not be null");
+
+ return new HGetDelCommand(null, new ArrayList<>(fields));
+ }
+
+ /**
+ * Applies the hash {@literal key}. Constructs a new command instance with all previously configured properties.
+ *
+ * @param key must not be {@literal null}.
+ * @return a new {@link HGetDelCommand} with {@literal key} applied.
+ */
+ public HGetDelCommand from(ByteBuffer key) {
+
+ Assert.notNull(key, "Key must not be null");
+
+ return new HGetDelCommand(key, getFields());
+ }
+ }
+
+
+ /**
+ * Get and delete the value of one or more {@literal fields} from hash at {@literal key}. Values are returned in the
+ * order of the requested keys. Absent field values are represented using {@literal null} in the resulting {@link List}.
+ * When the last field is deleted, the key will also be deleted.
+ *
+ * @param key must not be {@literal null}.
+ * @param fields must not be {@literal null}.
+ * @return never {@literal null}.
+ * @see <a href="https://redis.io/commands/hgetdel">Redis Documentation: HGETDEL</a>
+ */
+ default Mono<List<ByteBuffer>> hGetDel(ByteBuffer key, Collection<ByteBuffer> fields) {
+
+ Assert.notNull(key, "Key must not be null");
+ Assert.notNull(fields, "Fields must not be null");
+
+ return hGetDel(Mono.just(HGetDelCommand.fields(fields).from(key))).next().map(MultiValueResponse::getOutput);
+ }
+
+ /**
+ * Get and delete the value of one or more {@literal fields} from hash at {@literal key}. Values are returned in the
+ * order of the requested keys. Absent field values are represented using {@literal null} in the resulting {@link List}.
+ * When the last field is deleted, the key will also be deleted.
+ *
+ * @param commands must not be {@literal null}.
+ * @return never {@literal null}.
+ * @see <a href="https://redis.io/commands/hgetdel">Redis Documentation: HGETDEL</a>
+ */
+ Flux<MultiValueResponse<HGetDelCommand, ByteBuffer>> hGetDel(Publisher<HGetDelCommand> commands);
 }

src/main/java/org/springframework/data/redis/connection/RedisHashCommands.java

@@ -34,6 +34,7 @@
  * @author Christoph Strobl
  * @author Mark Paluch
  * @author Tihomir Mateev
+ * @author Viktoriya Kutsarova
  * @see RedisCommands
  */
 @NullUnmarked
@@ -541,4 +542,16 @@ default List<Long> hExpireAt(byte @NonNull [] key, long unixTime, byte @NonNull
  * @since 3.5
  */
 List<@NonNull Long> hpTtl(byte @NonNull [] key, byte @NonNull [] @NonNull... fields);
+
+ /**
+ * Get and delete the value of one or more {@code fields} from hash at {@code key}. Values are returned in the order of
+ * the requested keys. Absent field values are represented using {@literal null} in the resulting {@link List}.
+ * When the last field is deleted, the key will also be deleted.
+ *
+ * @param key must not be {@literal null}.
+ * @param fields must not be {@literal null}.
+ * @return empty {@link List} if key does not exist. {@literal null} when used in pipeline / transaction.
+ * @see <a href="https://redis.io/commands/hgetdel">Redis Documentation: HGETDEL</a>
+ */
+ List<byte[]> hGetDel(byte @NonNull [] key, byte @NonNull [] @NonNull... fields);
 }

src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java

@@ -2552,6 +2552,18 @@ List<Long> hpExpireAt(@NonNull String key, long unixTimeInMillis, ExpirationOpti
  */
 List<Long> hpTtl(@NonNull String key, @NonNull String @NonNull... fields);
 
+ /**
+ * Get and delete the value of one or more {@code fields} from hash at {@code key}. When the last field is deleted,
+ * the key will also be deleted.
+ *
+ * @param key must not be {@literal null}.
+ * @param fields must not be {@literal null}.
+ * @return empty {@link List} if key does not exist. {@literal null} when used in pipeline / transaction.
+ * @see <a href="https://redis.io/commands/hmget">Redis Documentation: HMGET</a>
+ * @see RedisHashCommands#hMGet(byte[], byte[]...)
+ */
+ List<String> hGetDel(@NonNull String key, @NonNull String @NonNull... fields);
+
 // -------------------------------------------------------------------------
 // Methods dealing with HyperLogLog
 // -------------------------------------------------------------------------

src/main/java/org/springframework/data/redis/connection/jedis/JedisClusterHashCommands.java

@@ -414,6 +414,20 @@ public List<Long> hpTtl(byte[] key, byte[]... fields) {
 }
 }
 
+ @Override
+ public List<byte[]> hGetDel(byte[] key, byte[]... fields) {
+
+ Assert.notNull(key, "Key must not be null");
+ Assert.notNull(fields, "Fields must not be null");
+
+ try {
+ return connection.getCluster().hgetdel(key, fields);
+ } catch (Exception ex) {
+ throw convertJedisAccessException(ex);
+ }
+
+ }
+
 @Nullable
 @Override
 public Long hStrLen(byte[] key, byte[] field) {

src/main/java/org/springframework/data/redis/connection/jedis/JedisHashCommands.java

@@ -332,6 +332,15 @@ protected void doClose() {
 return connection.invoke().just(Jedis::hpttl, PipelineBinaryCommands::hpttl, key, fields);
 }
 
+ @Override
+ public List<byte[]> hGetDel(byte @NonNull [] key, byte @NonNull [] @NonNull... fields) {
+
+ Assert.notNull(key, "Key must not be null");
+ Assert.notNull(fields, "Fields must not be null");
+
+ return connection.invoke().just(Jedis::hgetdel, PipelineBinaryCommands::hgetdel, key, fields);
+ }
+
 @Nullable
 @Override
 public Long hStrLen(byte[] key, byte[] field) {

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnection.java

@@ -1243,6 +1243,7 @@ static class TypeHints {
 COMMAND_OUTPUT_TYPE_MAPPING.put(ZRANGEBYSCORE, ValueListOutput.class);
 COMMAND_OUTPUT_TYPE_MAPPING.put(ZREVRANGE, ValueListOutput.class);
 COMMAND_OUTPUT_TYPE_MAPPING.put(ZREVRANGEBYSCORE, ValueListOutput.class);
+ COMMAND_OUTPUT_TYPE_MAPPING.put(HGETDEL, ValueListOutput.class);
 
 // BOOLEAN
 COMMAND_OUTPUT_TYPE_MAPPING.put(EXISTS, BooleanOutput.class);

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceHashCommands.java

@@ -265,6 +265,16 @@ public List<Long> hpTtl(byte @NonNull [] key, byte @NonNull [] @NonNull... field
 return connection.invoke().fromMany(RedisHashAsyncCommands::hpttl, key, fields).toList();
 }
 
+ @Override
+ public List<byte[]> hGetDel(byte @NonNull [] key, byte @NonNull []... fields) {
+
+ Assert.notNull(key, "Key must not be null");
+ Assert.notNull(fields, "Fields must not be null");
+
+ return connection.invoke().fromMany(RedisHashAsyncCommands::hgetdel, key, fields)
+ .toList(source -> source.getValueOrElse(null));
+ }
+
 /**
  * @param key
  * @param cursorId