Package io.quarkus.redis.datasource.autosuggest

Interface ReactiveTransactionalAutoSuggestCommands<K>

Type Parameters:
K - the type of the key
All Superinterfaces:
ReactiveTransactionalRedisCommands
All Known Implementing Classes:
ReactiveTransactionalAutoSuggestCommandsImpl
public interface ReactiveTransactionalAutoSuggestCommands<K> extends ReactiveTransactionalRedisCommands
Allows executing commands from the auto-suggest group (requires the Redis Search module from Redis stack). See the auto-suggest 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

    • ftSugAdd

      default io.smallrye.mutiny.Uni<Void> ftSugAdd(K key, String string, double score)
      Execute the command FT.SUGADD. Summary: Add a suggestion string to an auto-complete suggestion dictionary Group: auto-suggest
      Parameters:
      key - the suggestion dictionary key
      string - the suggestion string to index
      score - the floating point number of the suggestion string's weight
      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.

    • ftSugAdd

      io.smallrye.mutiny.Uni<Void> ftSugAdd(K key, String string, double score, boolean increment)
      Execute the command FT.SUGADD. Summary: Add a suggestion string to an auto-complete suggestion dictionary Group: auto-suggest
      Parameters:
      key - the suggestion dictionary key
      string - the suggestion string to index
      score - the floating point number of the suggestion string's weight
      increment - increments the existing entry of the suggestion by the given score, instead of replacing the score. This is useful for updating the dictionary based on user queries in real time.
      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.

    • ftSugDel

      io.smallrye.mutiny.Uni<Void> ftSugDel(K key, String string)
      Execute the command FT.SUGDEL. Summary: Delete a string from a suggestion index Group: auto-suggest
      Parameters:
      key - the suggestion dictionary key
      string - the suggestion string to index
      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.

    • ftSugget

      io.smallrye.mutiny.Uni<Void> ftSugget(K key, String prefix)
      Execute the command FT.SUGGET. Summary: Get completion suggestions for a prefix Group: auto-suggest
      Parameters:
      key - the suggestion dictionary key
      prefix - is prefix to complete on.
      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.

    • ftSugget

      io.smallrye.mutiny.Uni<Void> ftSugget(K key, String prefix, GetArgs args)
      Execute the command FT.SUGGET. Summary: Get completion suggestions for a prefix Group: auto-suggest
      Parameters:
      key - the suggestion dictionary key
      prefix - is prefix to complete on.
      args - the extra argument, 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.

    • ftSugLen

      io.smallrye.mutiny.Uni<Void> ftSugLen(K key)
      Execute the command FT.SUGLEN. Summary: Get the size of an auto-complete suggestion dictionary Group: auto-suggest
      Parameters:
      key - the suggestion dictionary key
      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.