Interface ReactiveGraphCommands<K>
-
- Type Parameters:
K
- the type of the key
- All Superinterfaces:
ReactiveRedisCommands
- All Known Implementing Classes:
ReactiveGraphCommandsImpl
public interface ReactiveGraphCommands<K> extends ReactiveRedisCommands
Allows executing commands from thegraph
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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description io.smallrye.mutiny.Uni<Void>
graphDelete(K key)
Execute the command GRAPH.DELETE.io.smallrye.mutiny.Uni<String>
graphExplain(K key, String query)
Execute the command GRAPH.EXPLAIN.io.smallrye.mutiny.Uni<List<K>>
graphList()
Execute the command GRAPH.LIST.io.smallrye.mutiny.Uni<List<Map<String,GraphQueryResponseItem>>>
graphQuery(K key, String query)
Execute the command GRAPH.QUERY.io.smallrye.mutiny.Uni<List<Map<String,GraphQueryResponseItem>>>
graphQuery(K key, String query, Duration timeout)
Execute the command GRAPH.QUERY.-
Methods inherited from interface io.quarkus.redis.datasource.ReactiveRedisCommands
getDataSource
-
-
-
-
Method Detail
-
graphDelete
io.smallrye.mutiny.Uni<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 benull
- Returns:
- a uni producing
null
when the operation completes
-
graphExplain
io.smallrye.mutiny.Uni<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 benull
query
- the query, must not benull
- Returns:
- a uni producing the string representation of the query execution plan
-
graphList
io.smallrye.mutiny.Uni<List<K>> graphList()
Execute the command GRAPH.LIST. Summary: Lists all graph keys in the keyspace. Group: graph- Returns:
- a uni producing the list of list of keys storing graphs
-
graphQuery
io.smallrye.mutiny.Uni<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 benull
query
- the query, must not benull
- 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, aGraphQueryResponseItem
is returned. It can represent a scalar item (GraphQueryResponseItem.ScalarItem
), a node (GraphQueryResponseItem.NodeItem
, or a relation (GraphQueryResponseItem.RelationItem
).
-
graphQuery
io.smallrye.mutiny.Uni<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 benull
query
- the query, must not benull
timeout
- a timeout, must not benull
- 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, aGraphQueryResponseItem
is returned. It can represent a scalar item (GraphQueryResponseItem.ScalarItem
), a node (GraphQueryResponseItem.NodeItem
, or a relation (GraphQueryResponseItem.RelationItem
).
-
-