Class BlockingSearchCommandsImpl<K>
java.lang.Object
io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup
io.quarkus.redis.runtime.datasource.BlockingSearchCommandsImpl<K>
- All Implemented Interfaces:
RedisCommands
,SearchCommands<K>
public class BlockingSearchCommandsImpl<K>
extends AbstractRedisCommandGroup
implements SearchCommands<K>
-
Field Summary
Fields inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup
ds, timeout
-
Constructor Summary
ConstructorDescriptionBlockingSearchCommandsImpl
(RedisDataSource ds, ReactiveSearchCommands<K> reactive, Duration timeout) -
Method Summary
Modifier and TypeMethodDescriptionft_list()
Execute the command FT._LIST.ftAggregate
(String indexName, String query) Execute the command FT.AGGREGATE.ftAggregate
(String indexName, String query, AggregateArgs args) Execute the command FT.AGGREGATE.void
ftAliasAdd
(String alias, String index) Execute the command FT.ALIASADD.void
ftAliasDel
(String alias) Execute the command FT.ALIASDEL.void
ftAliasUpdate
(String alias, String index) Execute the command FT.ALIASUPDATE.void
ftAlter
(String index, IndexedField field, boolean skipInitialScan) Execute the command FT.ALTER.void
ftCreate
(String index, CreateArgs args) Execute the command FT.CREATE.void
ftCursorDel
(String index, long cursor) Execute the command FT.CURSOR DEL.ftCursorRead
(String index, long cursor) Execute the command FT.CURSOR READ.ftCursorRead
(String index, long cursor, int count) Execute the command FT.CURSOR READ.void
Execute the command FT.DICTADD.void
Execute the command FT.DICTDEL.ftDictDump
(String dict) Execute the command FT.DICTDUMP.void
ftDropIndex
(String index) Execute the command FT.DROPINDEX.void
ftDropIndex
(String index, boolean dd) Execute the command FT.DROPINDEX.Execute the command FT.SEARCH.Execute the command FT.SEARCH.ftSpellCheck
(String index, String query) Execute the command FT.SPELLCHECK.ftSpellCheck
(String index, String query, SpellCheckArgs args) Execute the command FT.SPELLCHECK.Execute the command FT.SYNDUMP.void
ftSynUpdate
(String index, String groupId, boolean skipInitialScan, String... words) Execute the command FT.SYNUPDATE.void
ftSynUpdate
(String index, String groupId, String... words) Execute the command FT.SYNUPDATE.Execute the command FT.TAGVALS.Methods inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup
getDataSource
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.quarkus.redis.datasource.RedisCommands
getDataSource
Methods inherited from interface io.quarkus.redis.datasource.search.SearchCommands
ftAlter
-
Constructor Details
-
BlockingSearchCommandsImpl
public BlockingSearchCommandsImpl(RedisDataSource ds, ReactiveSearchCommands<K> reactive, Duration timeout)
-
-
Method Details
-
ft_list
Description copied from interface:SearchCommands
Execute the command FT._LIST. Summary: Returns a list of all existing indexes. Group: searchThis is a temporary command.
- Specified by:
ft_list
in interfaceSearchCommands<K>
- Returns:
- A uni emitting the list of the keys
-
ftAggregate
Description copied from interface:SearchCommands
Execute the command FT.AGGREGATE. Summary: Run a search query on an index, and perform aggregate transformations on the results, extracting statistics from them Group: search- Specified by:
ftAggregate
in interfaceSearchCommands<K>
- Parameters:
indexName
- the index against which the query is executed.query
- the filtering query that retrieves the documents. It follows the exact same syntax as the search query, including filters, unions, not, optional, and so on.args
- the extra parameters- Returns:
- A uni emitting the response to the aggregate
-
ftAggregate
Description copied from interface:SearchCommands
Execute the command FT.AGGREGATE. Summary: Run a search query on an index, and perform aggregate transformations on the results, extracting statistics from them Group: search- Specified by:
ftAggregate
in interfaceSearchCommands<K>
- Parameters:
indexName
- the index against which the query is executed.query
- the filtering query that retrieves the documents. It follows the exact same syntax as the search query, including filters, unions, not, optional, and so on.- Returns:
- A uni emitting the response to the query
-
ftAliasAdd
Description copied from interface:SearchCommands
Execute the command FT.ALIASADD. Summary: Add an alias to an index Group: search- Specified by:
ftAliasAdd
in interfaceSearchCommands<K>
- Parameters:
alias
- the alias to be added to an index.index
- the index
-
ftAliasDel
Description copied from interface:SearchCommands
Execute the command FT.ALIASDEL. Summary: Remove an alias from an index Group: search- Specified by:
ftAliasDel
in interfaceSearchCommands<K>
- Parameters:
alias
- the alias to be removed
-
ftAliasUpdate
Description copied from interface:SearchCommands
Execute the command FT.ALIASUPDATE. Summary: Add an alias to an index. If the alias is already associated with another index, FT.ALIASUPDATE removes the alias association with the previous index. Group: search- Specified by:
ftAliasUpdate
in interfaceSearchCommands<K>
- Parameters:
alias
- the alias to be added to an index.index
- the index
-
ftAlter
Description copied from interface:SearchCommands
Execute the command FT.ALTER. Summary: Add a new attribute to the index. Adding an attribute to the index causes any future document updates to use the new attribute when indexing and reindexing existing documents. Group: search- Specified by:
ftAlter
in interfaceSearchCommands<K>
- Parameters:
index
- the indexfield
- the indexed field to addskipInitialScan
- whether to skip the initial scan, if set totrue
, does not scan and index.
-
ftCreate
Description copied from interface:SearchCommands
Execute the command FT.CREATE. Summary: Create an index with the given specification. Group: search- Specified by:
ftCreate
in interfaceSearchCommands<K>
- Parameters:
index
- the indexargs
- the creation arguments.
-
ftCursorDel
Description copied from interface:SearchCommands
Execute the command FT.CURSOR DEL. Summary: Delete a cursor Group: search- Specified by:
ftCursorDel
in interfaceSearchCommands<K>
- Parameters:
index
- the indexcursor
- the cursor id
-
ftCursorRead
Description copied from interface:SearchCommands
Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search- Specified by:
ftCursorRead
in interfaceSearchCommands<K>
- Parameters:
index
- the indexcursor
- the cursor id- Returns:
- A uni emitting the aggregate response
-
ftCursorRead
Description copied from interface:SearchCommands
Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search- Specified by:
ftCursorRead
in interfaceSearchCommands<K>
- Parameters:
index
- the indexcursor
- the cursor idcount
- the number of results to read- Returns:
- A uni emitting the aggregate response. This parameter overrides
COUNT
specified inFT.AGGREGATE
.
-
ftDropIndex
Description copied from interface:SearchCommands
Execute the command FT.DROPINDEX. Summary: Delete an index Group: search- Specified by:
ftDropIndex
in interfaceSearchCommands<K>
- Parameters:
index
- the index
-
ftDropIndex
Description copied from interface:SearchCommands
Execute the command FT.DROPINDEX. Summary: Delete an index Group: search- Specified by:
ftDropIndex
in interfaceSearchCommands<K>
- Parameters:
index
- the indexdd
- drop operation that, if set, deletes the actual document hashes.
-
ftDictAdd
Description copied from interface:SearchCommands
Execute the command FT.DICTADD. Summary: Add terms to a dictionary Group: search- Specified by:
ftDictAdd
in interfaceSearchCommands<K>
- Parameters:
dict
- the dictionary namewords
- the terms to add to the dictionary
-
ftDictDel
Description copied from interface:SearchCommands
Execute the command FT.DICTDEL. Summary: Remove terms from a dictionary Group: search- Specified by:
ftDictDel
in interfaceSearchCommands<K>
- Parameters:
dict
- the dictionary namewords
- the terms to remove to the dictionary
-
ftDictDump
Description copied from interface:SearchCommands
Execute the command FT.DICTDUMP. Summary: Dump all terms in the given dictionary Group: search- Specified by:
ftDictDump
in interfaceSearchCommands<K>
- Parameters:
dict
- the dictionary name- Returns:
- A uni emitting the list of words (terms) included in the dictionary
-
ftSearch
Description copied from interface:SearchCommands
Execute the command FT.SEARCH. Summary: Search the index with a textual query, returning either documents or just ids Group: search- Specified by:
ftSearch
in interfaceSearchCommands<K>
- Parameters:
index
- the index name. You must first create the index usingFT.CREATE
.query
- the text query to search.args
- the extra parameters- Returns:
- A uni emitting the
SearchQueryResponse
-
ftSearch
Description copied from interface:SearchCommands
Execute the command FT.SEARCH. Summary: Search the index with a textual query, returning either documents or just ids Group: search- Specified by:
ftSearch
in interfaceSearchCommands<K>
- Parameters:
index
- the index name. You must first create the index usingFT.CREATE
.query
- the text query to search.- Returns:
- A uni emitting the
SearchQueryResponse
-
ftSpellCheck
Description copied from interface:SearchCommands
Execute the command FT.SPELLCHECK. Summary: Perform spelling correction on a query, returning suggestions for misspelled terms Group: search- Specified by:
ftSpellCheck
in interfaceSearchCommands<K>
- Parameters:
index
- the index name. You must first create the index usingFT.CREATE
.query
- the text query to search.- Returns:
- A uni emitting the
SpellCheckResponse
-
ftSpellCheck
Description copied from interface:SearchCommands
Execute the command FT.SPELLCHECK. Summary: Perform spelling correction on a query, returning suggestions for misspelled terms Group: search- Specified by:
ftSpellCheck
in interfaceSearchCommands<K>
- Parameters:
index
- the index name. You must first create the index usingFT.CREATE
.query
- the text query to search.args
- the extra parameters- Returns:
- A uni emitting the
SpellCheckResponse
-
ftSynDump
Description copied from interface:SearchCommands
Execute the command FT.SYNDUMP. Summary: Dump the contents of a synonym group Group: search- Specified by:
ftSynDump
in interfaceSearchCommands<K>
- Parameters:
index
- the index name.- Returns:
- A uni emitting the
SynDumpResponse
-
ftSynUpdate
Description copied from interface:SearchCommands
Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search- Specified by:
ftSynUpdate
in interfaceSearchCommands<K>
- Parameters:
index
- the index name.groupId
- the synonym groupwords
- the synonyms
-
ftSynUpdate
Description copied from interface:SearchCommands
Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search- Specified by:
ftSynUpdate
in interfaceSearchCommands<K>
- Parameters:
index
- the index name.groupId
- the synonym groupskipInitialScan
- if set totrue
, does not scan and index, and only documents that are indexed after the update are affected.words
- the synonyms
-
ftTagVals
Description copied from interface:SearchCommands
Execute the command FT.TAGVALS. Summary: return a distinct set of values indexed in a Tag field Group: search- Specified by:
ftTagVals
in interfaceSearchCommands<K>
- Parameters:
index
- the index name.field
- the name of a tag file defined in the schema.- Returns:
- A uni emitting the set of values indexed in a Tag field
-