Package io.quarkus.redis.datasource.graph

Interface GraphCommands<K>

Type Parameters:
K - the type of the key
All Superinterfaces:
RedisCommands
All Known Implementing Classes:
BlockingGraphCommandsImpl
@Experimental("The Redis graph support is experimental") public interface GraphCommands<K> extends RedisCommands
Allows executing commands from the graph group. These commands require the Redis Graph module to be installed in the Redis server.

See the graph command list for further information about these commands.

  • Method Details

    • graphDelete

      void graphDelete(K key)
      Execute the command GRAPH.DELETE. Summary: Completely removes the graph and all of its entities. Group: graph
      Parameters:
      key - the key, must not be null

    • graphExplain

      String graphExplain(K key, String query)
      Execute the command GRAPH.EXPLAIN. Summary: Constructs a query execution plan but does not run it. Inspect this execution plan to better understand how your query will get executed. Group: graph

      Parameters:
      key - the key, must not be null
      query - the query, must not be null
      Returns:
      the string representation of the query execution plan

    • graphList

      List<K> graphList()
      Execute the command GRAPH.LIST. Summary: Lists all graph keys in the keyspace. Group: graph

      Returns:
      the list of list of keys storing graphs

    • graphQuery

      List<Map<String,GraphQueryResponseItem>> graphQuery(K key, String query)
      Execute the command GRAPH.QUERY. Summary: Executes the given query against a specified graph. Group: graph

      Parameters:
      key - the key, must not be null
      query - the query, must not be null
      Returns:
      a map, potentially empty, containing the requested items to return. The map is empty if the query does not have a return clause. For each request item, a GraphQueryResponseItem is returned. It can represent a scalar item (GraphQueryResponseItem.ScalarItem), a node (GraphQueryResponseItem.NodeItem, or a relation (GraphQueryResponseItem.RelationItem).

    • graphQuery

      List<Map<String,GraphQueryResponseItem>> graphQuery(K key, String query, Duration timeout)
      Execute the command GRAPH.QUERY. Summary: Executes the given query against a specified graph. Group: graph

      Parameters:
      key - the key, must not be null
      query - the query, must not be null
      timeout - a timeout, must not be null
      Returns:
      a map, potentially empty, containing the requested items to return. The map is empty if the query does not have a return clause. For each request item, a GraphQueryResponseItem is returned. It can represent a scalar item (GraphQueryResponseItem.ScalarItem), a node (GraphQueryResponseItem.NodeItem, or a relation (GraphQueryResponseItem.RelationItem).