Interface AutoSuggestCommands<K>
- Type Parameters:
K
- the type of the key
- All Superinterfaces:
RedisCommands
- All Known Implementing Classes:
BlockingAutoSuggestCommandsImpl
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
Methods inherited from interface io.quarkus.redis.datasource.RedisCommands
getDataSource
-
Method Details
-
ftSugAdd
Execute the command FT.SUGADD. Summary: Add a suggestion string to an auto-complete suggestion dictionary Group: auto-suggest- Parameters:
key
- the suggestion dictionary keystring
- the suggestion string to indexscore
- the floating point number of the suggestion string's weight- Returns:
- A uni emitting the current size of the suggestion dictionary.
-
ftSugAdd
Execute the command FT.SUGADD. Summary: Add a suggestion string to an auto-complete suggestion dictionary Group: auto-suggest- Parameters:
key
- the suggestion dictionary keystring
- the suggestion string to indexscore
- the floating point number of the suggestion string's weightincrement
- 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
Execute the command FT.SUGDEL. Summary: Delete a string from a suggestion index Group: auto-suggest- Parameters:
key
- the suggestion dictionary keystring
- the suggestion string to index- Returns:
- A uni emitting
true
if the value was found,false
otherwise
-
ftSugGet
Execute the command FT.SUGGET. Summary: Get completion suggestions for a prefix Group: auto-suggest- Parameters:
key
- the suggestion dictionary keyprefix
- 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
Execute the command FT.SUGGET. Summary: Get completion suggestions for a prefix Group: auto-suggest- Parameters:
key
- the suggestion dictionary keyprefix
- is prefix to complete on.args
- the extra argument, must not benull
- Returns:
- A uni emitting
true
if the value was found,false
otherwise
-
ftSugLen
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.
-