Implement flush modes in flushdb

See spring-projects#2187

Author: schnapster

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

@@ -75,6 +75,7 @@
  * @author Andrey Shlykov
  * @author dengliming
  * @author ihaohong
+ * @author Dennis Neufeld
  */
 public class DefaultStringRedisConnection implements StringRedisConnection, DecoratedRedisConnection {
 
@@ -410,6 +411,15 @@ public void flushDb() {
 		delegate.flushDb();
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#flushDb(org.springframework.data.redis.connection.RedisServerCommands.FlushOption)
+	 */
+	@Override
+	public void flushDb(FlushOption option) {
+		delegate.flushDb(option);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisStringCommands#get(byte[])

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

@@ -27,6 +27,7 @@
 /**
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author Dennis Neufeld
  * @since 2.0
  */
 public interface DefaultedRedisClusterConnection extends RedisClusterConnection, DefaultedRedisConnection {
@@ -73,6 +74,13 @@ default void flushDb(RedisClusterNode node) {
 		serverCommands().flushDb(node);
 	}
 
+	/** @deprecated in favor of {@link RedisConnection#serverCommands()}. */
+	@Override
+	@Deprecated
+	default void flushDb(RedisClusterNode node, FlushOption option) {
+		serverCommands().flushDb(node, option);
+	}
+
 	/** @deprecated in favor of {@link RedisConnection#serverCommands()}. */
 	@Override
 	@Deprecated

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

@@ -60,6 +60,7 @@
  * @author Andrey Shlykov
  * @author dengliming
  * @author ihaohong
+ * @author Dennis Neufeld
  * @since 2.0
  */
 public interface DefaultedRedisConnection extends RedisConnection {
@@ -1632,6 +1633,13 @@ default void flushDb() {
 		serverCommands().flushDb();
 	}
 
+	/** @deprecated in favor of {@link RedisConnection#serverCommands()}. */
+	@Override
+	@Deprecated
+	default void flushDb(FlushOption option) {
+		serverCommands().flushDb(option);
+	}
+
 	/** @deprecated in favor of {@link RedisConnection#serverCommands()}. */
 	@Override
 	@Deprecated

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

@@ -20,13 +20,15 @@
 
 import java.util.Properties;
 
+import org.springframework.data.redis.connection.RedisServerCommands.FlushOption;
 import org.springframework.data.redis.core.types.RedisClientInfo;
 
 /**
  * Redis Server commands executed in cluster environment using reactive infrastructure.
  *
  * @author Mark Paluch
  * @author Christoph Strobl
+ * @author Dennis Neufeld
  * @since 2.0
  */
 public interface ReactiveClusterServerCommands extends ReactiveServerCommands {
@@ -91,6 +93,17 @@ public interface ReactiveClusterServerCommands extends ReactiveServerCommands {
 	 */
 	Mono<String> flushDb(RedisClusterNode node);
 
+	/**
+	 * Delete all keys of the currently selected database using the specified flush option.
+	 *
+	 * @param node must not be {@literal null}. {@link Mono} indicating command completion.
+	 * @param option
+	 * @throws IllegalArgumentException when {@code node} is {@literal null}.
+	 * @see RedisServerCommands#flushDb(FlushOption)
+	 * @since 2.6
+	 */
+	Mono<String> flushDb(RedisClusterNode node, FlushOption option);
+
 	/**
 	 * Delete all <b>all keys</b> from <b>all databases</b>.
 	 *

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

@@ -21,13 +21,15 @@
 import java.util.Properties;
 import java.util.concurrent.TimeUnit;
 
+import org.springframework.data.redis.connection.RedisServerCommands.FlushOption;
 import org.springframework.data.redis.core.types.RedisClientInfo;
 
 /**
  * Redis Server commands executed using reactive infrastructure.
  *
  * @author Mark Paluch
  * @author Christoph Strobl
+ * @author Dennis Neufeld
  * @since 2.0
  */
 public interface ReactiveServerCommands {
@@ -81,6 +83,16 @@ public interface ReactiveServerCommands {
 	 */
 	Mono<String> flushDb();
 
+	/**
+	 * Delete all keys of the currently selected database using the specified flush option.
+	 *
+	 * @param option
+	 * @return {@link Mono} indicating command completion.
+	 * @see <a href="https://redis.io/commands/flushdb">Redis Documentation: FLUSHDB</a>
+	 * @since 2.6
+	 */
+	Mono<String> flushDb(FlushOption option);
+
 	/**
 	 * Delete all <b>all keys</b> from <b>all databases</b>.
 	 *

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

@@ -23,6 +23,7 @@
 
 /**
  * @author Mark Paluch
+ * @author Dennis Neufeld
  * @since 2.0
  */
 public interface RedisClusterServerCommands extends RedisServerCommands {
@@ -65,6 +66,14 @@ public interface RedisClusterServerCommands extends RedisServerCommands {
 	 */
 	void flushDb(RedisClusterNode node);
 
+	/**
+	 * @param node must not be {@literal null}.
+	 * @param option
+	 * @see RedisServerCommands#flushDb(FlushOption)
+	 * @since 2.6
+	 */
+	void flushDb(RedisClusterNode node, FlushOption option);
+
 	/**
 	 * @param node must not be {@literal null}.
 	 * @see RedisServerCommands#flushAll()

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

@@ -29,6 +29,7 @@
  * @author Christoph Strobl
  * @author Thomas Darimont
  * @author Mark Paluch
+ * @author Dennis Neufeld
  */
 public interface RedisServerCommands {
 
@@ -43,6 +44,13 @@ enum MigrateOption {
 		COPY, REPLACE
 	}
 
+	/**
+	 * @since 2.6
+	 */
+	enum FlushOption {
+		SYNC, ASYNC
+	}
+
 	/**
 	 * Start an {@literal Append Only File} rewrite process on server.
 	 *
@@ -101,6 +109,15 @@ default void bgWriteAof() {
 	 */
 	void flushDb();
 
+	/**
+	 * Delete all keys of the currently selected database using the specified flush option.
+	 *
+	 * @param option
+	 * @see <a href="https://redis.io/commands/flushdb">Redis Documentation: FLUSHDB</a>
+	 * @since 2.6
+	 */
+	void flushDb(FlushOption option);
+
 	/**
 	 * Delete all <b>all keys</b> from <b>all databases</b>.
 	 *

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

@@ -17,6 +17,7 @@
 
 import redis.clients.jedis.BinaryJedis;
 import redis.clients.jedis.Jedis;
+import redis.clients.jedis.args.FlushMode;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -41,6 +42,7 @@
 
 /**
  * @author Mark Paluch
+ * @author Dennis Neufeld
  * @since 2.0
  */
 class JedisClusterServerCommands implements RedisClusterServerCommands {
@@ -171,6 +173,15 @@ public void flushDb() {
 		executeCommandOnAllNodes(BinaryJedis::flushDB);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#flushDb(org.springframework.data.redis.connection.RedisServerCommands.FlushOption)
+	 */
+	@Override
+	public void flushDb(FlushOption option) {
+		executeCommandOnAllNodes(it -> it.flushDB(toFlushMode(option)));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisClusterServerCommands#flushDb(org.springframework.data.redis.connection.RedisClusterNode)
@@ -180,6 +191,15 @@ public void flushDb(RedisClusterNode node) {
 		executeCommandOnSingleNode(BinaryJedis::flushDB, node);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisClusterServerCommands#flushDb(org.springframework.data.redis.connection.RedisClusterNode, org.springframework.data.redis.connection.RedisServerCommands.FlushOption)
+	 */
+	@Override
+	public void flushDb(RedisClusterNode node, FlushOption option) {
+		executeCommandOnSingleNode(it -> it.flushDB(toFlushMode(option)), node);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisServerCommands#flushAll()
@@ -555,4 +575,19 @@ private <T> NodeResult<T> executeCommandOnSingleNode(JedisClusterCommandCallback
 	private <T> MultiNodeResult<T> executeCommandOnAllNodes(JedisClusterCommandCallback<T> cmd) {
 		return connection.getClusterCommandExecutor().executeCommandOnAllNodes(cmd);
 	}
+
+	static FlushMode toFlushMode(@Nullable FlushOption option) {
+
+		if (option == null) {
+			return FlushMode.SYNC;
+		}
+
+		switch (option) {
+			case ASYNC:
+				return FlushMode.ASYNC;
+			case SYNC:
+				return FlushMode.SYNC;
+		}
+		throw new UnsupportedOperationException("Flush option " + option + " is not implemented.");
+	}
 }

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

@@ -18,6 +18,7 @@
 import redis.clients.jedis.BinaryJedis;
 import redis.clients.jedis.Jedis;
 import redis.clients.jedis.MultiKeyPipelineBase;
+import redis.clients.jedis.args.FlushMode;
 import redis.clients.jedis.args.SaveMode;
 
 import java.util.List;
@@ -33,6 +34,7 @@
 
 /**
  * @author Mark Paluch
+ * @author Dennis Neufeld
  * @since 2.0
  */
 class JedisServerCommands implements RedisServerCommands {
@@ -99,6 +101,17 @@ public void flushDb() {
 		connection.invokeStatus().just(BinaryJedis::flushDB, MultiKeyPipelineBase::flushDB);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisServerCommands#flushDb(org.springframework.data.redis.connection.RedisServerCommands.FlushOption)
+	 */
+	@Override
+	public void flushDb(FlushOption option) {
+
+		FlushMode flushMode = JedisClusterServerCommands.toFlushMode(option);
+		connection.invokeStatus().just(it -> it.flushDB(flushMode), it -> it.flushDB(flushMode));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisServerCommands#flushAll()

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

@@ -38,6 +38,7 @@
 
 /**
  * @author Mark Paluch
+ * @author Dennis Neufeld
  * @since 2.0
  */
 class LettuceClusterServerCommands extends LettuceServerCommands implements RedisClusterServerCommands {
@@ -124,6 +125,15 @@ public void flushDb() {
 		executeCommandOnAllNodes(RedisServerCommands::flushdb);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.lettuce.LettuceServerCommands#flushDb(org.springframework.data.redis.connection.RedisServerCommands.FlushOption)
+	 */
+	@Override
+	public void flushDb(FlushOption option) {
+		executeCommandOnAllNodes(it -> it.flushdb(toFlushMode(option)));
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisClusterServerCommands#flushDb(org.springframework.data.redis.connection.RedisClusterNode)
@@ -133,6 +143,15 @@ public void flushDb(RedisClusterNode node) {
 		executeCommandOnSingleNode(RedisServerCommands::flushdb, node);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisClusterServerCommands#flushDb(org.springframework.data.redis.connection.RedisClusterNode, org.springframework.data.redis.connection.RedisServerCommands.FlushOption)
+	 */
+	@Override
+	public void flushDb(RedisClusterNode node, FlushOption option) {
+		executeCommandOnSingleNode(it -> it.flushdb(toFlushMode(option)), node);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.lettuce.LettuceServerCommands#flushAll()

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

@@ -41,6 +41,7 @@
 import org.springframework.data.redis.connection.ClusterTopologyProvider;
 import org.springframework.data.redis.connection.ReactiveClusterServerCommands;
 import org.springframework.data.redis.connection.RedisClusterNode;
+import org.springframework.data.redis.connection.RedisServerCommands.FlushOption;
 import org.springframework.data.redis.core.types.RedisClientInfo;
 import org.springframework.data.redis.util.ByteUtils;
 import org.springframework.util.Assert;
@@ -50,6 +51,7 @@
  *
  * @author Mark Paluch
  * @author Christoph Strobl
+ * @author Dennis Neufeld
  * @since 2.0
  */
 class LettuceReactiveClusterServerCommands extends LettuceReactiveServerCommands
@@ -129,6 +131,15 @@ public Mono<String> flushDb(RedisClusterNode node) {
 		return connection.execute(node, RedisServerReactiveCommands::flushdb).next();
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.ReactiveClusterServerCommands#flushDb(org.springframework.data.redis.connection.RedisClusterNode, org.springframework.data.redis.connection.RedisServerCommands.FlushOption)
+	 */
+	@Override
+	public Mono<String> flushDb(RedisClusterNode node, FlushOption option) {
+		return connection.execute(node, it -> it.flushdb(LettuceServerCommands.toFlushMode(option))).next();
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.ReactiveClusterServerCommands#flushAll(org.springframework.data.redis.connection.RedisClusterNode)