Package io.quarkus.redis.datasource.graph

Interface ReactiveTransactionalGraphCommands<K>

Type Parameters:
K - the type of the key
All Superinterfaces:
ReactiveTransactionalRedisCommands
All Known Implementing Classes:
ReactiveTransactionalGraphCommandsImpl
public interface ReactiveTransactionalGraphCommands<K> extends ReactiveTransactionalRedisCommands
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.

This API is intended to be used in a Redis transaction (MULTI), thus, all command methods return Uni<Void>.

  • Method Details

    • 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 be null
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • graphExplain

      io.smallrye.mutiny.Uni<Void> 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:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • graphList

      io.smallrye.mutiny.Uni<Void> graphList()
      Execute the command GRAPH.LIST. Summary: Lists all graph keys in the keyspace. Group: graph

      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • graphQuery

      io.smallrye.mutiny.Uni<Void> 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 Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • graphQuery

      io.smallrye.mutiny.Uni<Void> 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 Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.