Interface TransactionalAutoSuggestCommands<K>
-
- Type Parameters:
K
- the type of the key
- All Superinterfaces:
TransactionalRedisCommands
- All Known Implementing Classes:
BlockingTransactionalAutoSuggestCommandsImpl
public interface TransactionalAutoSuggestCommands<K> extends TransactionalRedisCommands
Allows executing commands from theauto-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 returnvoid
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
ftSugAdd(K key, String string, double score)
Execute the command FT.SUGADD.void
ftSugAdd(K key, String string, double score, boolean increment)
Execute the command FT.SUGADD.void
ftSugDel(K key, String string)
Execute the command FT.SUGDEL.void
ftSugget(K key, String prefix)
Execute the command FT.SUGGET.void
ftSugget(K key, String prefix, GetArgs args)
Execute the command FT.SUGGET.void
ftSugLen(K key)
Execute the command FT.SUGLEN.-
Methods inherited from interface io.quarkus.redis.datasource.TransactionalRedisCommands
getDataSource
-
-
-
-
Method Detail
-
ftSugAdd
default 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 keystring
- the suggestion string to indexscore
- the floating point number of the suggestion string's weight
-
ftSugAdd
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 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.
-
ftSugDel
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 keystring
- the suggestion string to index
-
ftSugget
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 keyprefix
- is prefix to complete on.
-
ftSugget
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 keyprefix
- is prefix to complete on.args
- the extra argument, must not benull
-
-