Package io.quarkus.redis.datasource.autosuggest

Interface AutoSuggestCommands<K>

Type Parameters:

K - the type of the key

All Superinterfaces:

RedisCommands

All Known Implementing Classes:

BlockingAutoSuggestCommandsImpl

public interface AutoSuggestCommands<K>
extends RedisCommands

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.

Method Summary

Modifier and Type	Method	Description
default long	ftSugAdd(K key, String string, double score)	Execute the command FT.SUGADD.
long	ftSugAdd(K key, String string, double score, boolean increment)	Execute the command FT.SUGADD.
boolean	ftSugDel(K key, String string)	Execute the command FT.SUGDEL.
List<Suggestion>	ftSugGet(K key, String prefix)	Execute the command FT.SUGGET.
List<Suggestion>	ftSugGet(K key, String prefix, GetArgs args)	Execute the command FT.SUGGET.
long	ftSugLen(K key)	Execute the command FT.SUGLEN.

Methods inherited from interface io.quarkus.redis.datasource.RedisCommands

getDataSource

Method Detail

ftSugAdd

default long 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 the current size of the suggestion dictionary.

ftSugAdd

long 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 the current size of the suggestion dictionary.

ftSugDel

boolean 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 true if the value was found, false otherwise

ftSugGet

List<Suggestion> 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 a list of the top suggestions matching the prefix, optionally with score after each entry.

ftSugGet

List<Suggestion> 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 true if the value was found, false otherwise

ftSugLen

long 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 the current size of the suggestion dictionary.