Deprecate RedisGraph support (#3504)

* Deprecate Redis Graph support * in RedisGraphPipelineCommands
redis · Aug 17, 2023 · 155acfd · 155acfd
1 parent c9f4dee
commit 155acfd
Show file tree

Hide file tree

Showing 20 changed files with 117 additions and 7 deletions.
diff --git a/src/main/java/redis/clients/jedis/CommandObjects.java b/src/main/java/redis/clients/jedis/CommandObjects.java
@@ -4187,26 +4187,32 @@ public final CommandObject<List<Double>> tdigestByRevRank(String key, long... ra
   // RedisBloom commands
 
   // RedisGraph commands
+  @Deprecated
   public final CommandObject<List<String>> graphList() {
     return new CommandObject<>(commandArguments(GraphCommand.LIST), BuilderFactory.STRING_LIST);
   }
 
+  @Deprecated
   public final CommandObject<List<String>> graphProfile(String graphName, String query) {
     return new CommandObject<>(commandArguments(GraphCommand.PROFILE).key(graphName).add(query), BuilderFactory.STRING_LIST);
   }
 
+  @Deprecated
   public final CommandObject<List<String>> graphExplain(String graphName, String query) {
     return new CommandObject<>(commandArguments(GraphCommand.EXPLAIN).key(graphName).add(query), BuilderFactory.STRING_LIST);
   }
 
+  @Deprecated
   public final CommandObject<List<List<Object>>> graphSlowlog(String graphName) {
     return new CommandObject<>(commandArguments(GraphCommand.SLOWLOG).key(graphName), BuilderFactory.ENCODED_OBJECT_LIST_LIST);
   }
 
+  @Deprecated
   public final CommandObject<String> graphConfigSet(String configName, Object value) {
     return new CommandObject<>(commandArguments(GraphCommand.CONFIG).add(GraphKeyword.SET).add(configName).add(value), BuilderFactory.STRING);
   }
 
+  @Deprecated
   public final CommandObject<Map<String, Object>> graphConfigGet(String configName) {
     return new CommandObject<>(commandArguments(GraphCommand.CONFIG).add(GraphKeyword.GET).add(configName), BuilderFactory.ENCODED_OBJECT_MAP);
   }

diff --git a/src/main/java/redis/clients/jedis/UnifiedJedis.java b/src/main/java/redis/clients/jedis/UnifiedJedis.java
@@ -4699,76 +4699,91 @@ public List<Double> tdigestByRevRank(String key, long... ranks) {
 
   // RedisGraph commands
   @Override
+  @Deprecated
   public ResultSet graphQuery(String name, String query) {
     return executeCommand(graphCommandObjects.graphQuery(name, query));
   }
 
   @Override
+  @Deprecated
   public ResultSet graphReadonlyQuery(String name, String query) {
     return executeCommand(graphCommandObjects.graphReadonlyQuery(name, query));
   }
 
   @Override
+  @Deprecated
   public ResultSet graphQuery(String name, String query, long timeout) {
     return executeCommand(graphCommandObjects.graphQuery(name, query, timeout));
   }
 
   @Override
+  @Deprecated
   public ResultSet graphReadonlyQuery(String name, String query, long timeout) {
     return executeCommand(graphCommandObjects.graphReadonlyQuery(name, query, timeout));
   }
 
   @Override
+  @Deprecated
   public ResultSet graphQuery(String name, String query, Map<String, Object> params) {
     return executeCommand(graphCommandObjects.graphQuery(name, query, params));
   }
 
   @Override
+  @Deprecated
   public ResultSet graphReadonlyQuery(String name, String query, Map<String, Object> params) {
     return executeCommand(graphCommandObjects.graphReadonlyQuery(name, query, params));
   }
 
   @Override
+  @Deprecated
   public ResultSet graphQuery(String name, String query, Map<String, Object> params, long timeout) {
     return executeCommand(graphCommandObjects.graphQuery(name, query, params, timeout));
   }
 
   @Override
+  @Deprecated
   public ResultSet graphReadonlyQuery(String name, String query, Map<String, Object> params, long timeout) {
     return executeCommand(graphCommandObjects.graphReadonlyQuery(name, query, params, timeout));
   }
 
   @Override
+  @Deprecated
   public String graphDelete(String name) {
     return executeCommand(graphCommandObjects.graphDelete(name));
   }
 
   @Override
+  @Deprecated
   public List<String> graphList() {
     return executeCommand(commandObjects.graphList());
   }
 
   @Override
+  @Deprecated
   public List<String> graphProfile(String graphName, String query) {
     return executeCommand(commandObjects.graphProfile(graphName, query));
   }
 
   @Override
+  @Deprecated
   public List<String> graphExplain(String graphName, String query) {
     return executeCommand(commandObjects.graphExplain(graphName, query));
   }
 
   @Override
+  @Deprecated
   public List<List<Object>> graphSlowlog(String graphName) {
     return executeCommand(commandObjects.graphSlowlog(graphName));
   }
 
   @Override
+  @Deprecated
   public String graphConfigSet(String configName, Object value) {
     return executeCommand(commandObjects.graphConfigSet(configName, value));
   }
 
   @Override
+  @Deprecated
   public Map<String, Object> graphConfigGet(String configName) {
     return executeCommand(commandObjects.graphConfigGet(configName));
   }

diff --git a/src/main/java/redis/clients/jedis/graph/GraphCache.java b/src/main/java/redis/clients/jedis/graph/GraphCache.java
@@ -3,7 +3,9 @@
 /**
  * Store a local cache in the client, for a specific graph. Holds the labels, property names and
  * relationship types.
+ * @deprecated Redis Graph support is deprecated.
  */
+@Deprecated
 interface GraphCache {
 
   /**

diff --git a/src/main/java/redis/clients/jedis/graph/GraphCommandObjects.java b/src/main/java/redis/clients/jedis/graph/GraphCommandObjects.java
@@ -19,6 +19,10 @@
 import redis.clients.jedis.graph.GraphProtocol.GraphCommand;
 import redis.clients.jedis.providers.ConnectionProvider;
 
+/**
+ * @deprecated Redis Graph support is deprecated.
+ */
+@Deprecated
 public class GraphCommandObjects {
 
   private final RedisGraphCommands graph;

diff --git a/src/main/java/redis/clients/jedis/graph/GraphProtocol.java b/src/main/java/redis/clients/jedis/graph/GraphProtocol.java
@@ -4,8 +4,10 @@
 import redis.clients.jedis.commands.ProtocolCommand;
 import redis.clients.jedis.util.SafeEncoder;
 
+@Deprecated
 public class GraphProtocol {
 
+  @Deprecated
   public enum GraphCommand implements ProtocolCommand {
 
     QUERY,
@@ -29,6 +31,7 @@ public byte[] getRaw() {
     }
   }
 
+  @Deprecated
   public enum GraphKeyword implements Rawable {
 
     CYPHER,

diff --git a/src/main/java/redis/clients/jedis/graph/GraphQueryParams.java b/src/main/java/redis/clients/jedis/graph/GraphQueryParams.java
@@ -2,15 +2,16 @@
 
 import java.util.HashMap;
 import java.util.Map;
-import java.util.function.Function;
 
 import redis.clients.jedis.CommandArguments;
-import redis.clients.jedis.commands.ProtocolCommand;
 import redis.clients.jedis.exceptions.JedisException;
-import redis.clients.jedis.graph.GraphProtocol.GraphCommand;
 import redis.clients.jedis.graph.GraphProtocol.GraphKeyword;
 import redis.clients.jedis.params.IParams;
 
+/**
+ * @deprecated Redis Graph support is deprecated.
+ */
+@Deprecated
 public class GraphQueryParams implements IParams {
 
   private boolean readonly;

diff --git a/src/main/java/redis/clients/jedis/graph/Header.java b/src/main/java/redis/clients/jedis/graph/Header.java
@@ -3,8 +3,10 @@
 import java.util.List;
 
 /**
- * Query response header interface. Represents the response schema (column names and types)
+ * Query response header interface. Represents the response schema (column names and types).
+ * @deprecated Redis Graph support is deprecated.
  */
+@Deprecated
 public interface Header {
 
   List<ResultSet.ColumnType> getSchemaTypes();

diff --git a/src/main/java/redis/clients/jedis/graph/Record.java b/src/main/java/redis/clients/jedis/graph/Record.java
@@ -6,7 +6,10 @@
  * Container for RedisGraph result values.
  *
  * List records are returned from RedisGraph statement execution, contained within a ResultSet.
+ *
+ * @deprecated Redis Graph support is deprecated.
  */
+@Deprecated
 public interface Record {
 
   /**

diff --git a/src/main/java/redis/clients/jedis/graph/RedisGraphCommands.java b/src/main/java/redis/clients/jedis/graph/RedisGraphCommands.java
@@ -3,6 +3,10 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * @deprecated Redis Graph support is deprecated.
+ */
+@Deprecated
 public interface RedisGraphCommands {
 
   /**
@@ -11,7 +15,9 @@ public interface RedisGraphCommands {
    * @param name a graph to perform the query on
    * @param query Cypher query
    * @return a result set
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   ResultSet graphQuery(String name, String query);
 
   /**
@@ -20,7 +26,9 @@ public interface RedisGraphCommands {
    * @param name a graph to perform the query on
    * @param query Cypher query
    * @return a result set
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   ResultSet graphReadonlyQuery(String name, String query);
 
   /**
@@ -30,7 +38,9 @@ public interface RedisGraphCommands {
    * @param query Cypher query
    * @param timeout
    * @return a result set
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   ResultSet graphQuery(String name, String query, long timeout);
 
   /**
@@ -40,7 +50,9 @@ public interface RedisGraphCommands {
    * @param query Cypher query
    * @param timeout
    * @return a result set
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   ResultSet graphReadonlyQuery(String name, String query, long timeout);
 
   /**
@@ -50,7 +62,9 @@ public interface RedisGraphCommands {
    * @param query Cypher query.
    * @param params parameters map.
    * @return a result set.
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   ResultSet graphQuery(String name, String query, Map<String, Object> params);
 
   /**
@@ -60,7 +74,9 @@ public interface RedisGraphCommands {
    * @param query Cypher query.
    * @param params parameters map.
    * @return a result set.
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   ResultSet graphReadonlyQuery(String name, String query, Map<String, Object> params);
 
   /**
@@ -71,7 +87,9 @@ public interface RedisGraphCommands {
    * @param params parameters map.
    * @param timeout
    * @return a result set.
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   ResultSet graphQuery(String name, String query, Map<String, Object> params, long timeout);
 
   /**
@@ -82,40 +100,54 @@ public interface RedisGraphCommands {
    * @param params parameters map.
    * @param timeout
    * @return a result set.
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   ResultSet graphReadonlyQuery(String name, String query, Map<String, Object> params, long timeout);
 
   /**
    * Deletes the entire graph
    *
    * @param name graph to delete
    * @return delete running time statistics
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   String graphDelete(String name);
 
   /**
    * Lists all graph keys in the keyspace.
    * @return graph keys
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   List<String> graphList();
 
   /**
    * Executes a query and produces an execution plan augmented with metrics for each operation's execution.
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   List<String> graphProfile(String graphName, String query);
 
   /**
    * Constructs a query execution plan but does not run it. Inspect this execution plan to better understand how your
    * query will get executed.
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   List<String> graphExplain(String graphName, String query);
 
   /**
    * Returns a list containing up to 10 of the slowest queries issued against the given graph ID.
+   * @deprecated Redis Graph support is deprecated.
    */
+  @Deprecated
   List<List<Object>> graphSlowlog(String graphName);
 
+  @Deprecated
   String graphConfigSet(String configName, Object value);
 
+  @Deprecated
   Map<String, Object> graphConfigGet(String configName);
 }
diff --git a/src/main/java/redis/clients/jedis/graph/RedisGraphPipelineCommands.java b/src/main/java/redis/clients/jedis/graph/RedisGraphPipelineCommands.java
@@ -4,25 +4,39 @@
 import java.util.Map;
 import redis.clients.jedis.Response;
 
+/**
+ * @deprecated Redis Graph support is deprecated.
+ */
+@Deprecated
 public interface RedisGraphPipelineCommands {
 
+  @Deprecated
   Response<ResultSet> graphQuery(String name, String query);
 
+  @Deprecated
   Response<ResultSet> graphReadonlyQuery(String name, String query);
 
+  @Deprecated
   Response<ResultSet> graphQuery(String name, String query, long timeout);
 
+  @Deprecated
   Response<ResultSet> graphReadonlyQuery(String name, String query, long timeout);
 
+  @Deprecated
   Response<ResultSet> graphQuery(String name, String query, Map<String, Object> params);
 
+  @Deprecated
   Response<ResultSet> graphReadonlyQuery(String name, String query, Map<String, Object> params);
 
+  @Deprecated
   Response<ResultSet> graphQuery(String name, String query, Map<String, Object> params, long timeout);
 
+  @Deprecated
   Response<ResultSet> graphReadonlyQuery(String name, String query, Map<String, Object> params, long timeout);
 
+  @Deprecated
   Response<String> graphDelete(String name);
 
+  @Deprecated
   Response<List<String>> graphProfile(String graphName, String query);
 }