Class ReactiveSearchCommandsImpl<K>
java.lang.Object
io.quarkus.redis.runtime.datasource.AbstractRedisCommands
io.quarkus.redis.runtime.datasource.AbstractSearchCommands<K>
io.quarkus.redis.runtime.datasource.ReactiveSearchCommandsImpl<K>
- All Implemented Interfaces:
ReactiveRedisCommands
,ReactiveSearchCommands<K>
public class ReactiveSearchCommandsImpl<K>
extends AbstractSearchCommands<K>
implements ReactiveSearchCommands<K>, ReactiveRedisCommands
-
Field Summary
Fields inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommands
marshaller, redis
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription(package private) AggregationResponse
decodeAggregateResponse
(io.vertx.mutiny.redis.client.Response response, boolean cursor) (package private) SearchQueryResponse
decodeSearchQueryResult
(io.vertx.mutiny.redis.client.Response response, QueryArgs args) (package private) SpellCheckResponse
decodeSpellcheckResponse
(io.vertx.mutiny.redis.client.Response response) (package private) SynDumpResponse
decodeSynDumpResponse
(io.vertx.mutiny.redis.client.Response r) ft_list()
Execute the command FT._LIST.io.smallrye.mutiny.Uni<AggregationResponse>
ftAggregate
(String indexName, String query) Execute the command FT.AGGREGATE.io.smallrye.mutiny.Uni<AggregationResponse>
ftAggregate
(String indexName, String query, AggregateArgs args) Execute the command FT.AGGREGATE.io.smallrye.mutiny.Uni<Void>
ftAliasAdd
(String alias, String index) Execute the command FT.ALIASADD.io.smallrye.mutiny.Uni<Void>
ftAliasDel
(String alias) Execute the command FT.ALIASDEL.io.smallrye.mutiny.Uni<Void>
ftAliasUpdate
(String alias, String index) Execute the command FT.ALIASUPDATE.io.smallrye.mutiny.Uni<Void>
ftAlter
(String index, IndexedField field, boolean skipInitialScan) Execute the command FT.ALTER.io.smallrye.mutiny.Uni<Void>
ftCreate
(String index, CreateArgs args) Execute the command FT.CREATE.io.smallrye.mutiny.Uni<Void>
ftCursorDel
(String index, long cursor) Execute the command FT.CURSOR DEL.io.smallrye.mutiny.Uni<AggregationResponse>
ftCursorRead
(String index, long cursor) Execute the command FT.CURSOR READ.io.smallrye.mutiny.Uni<AggregationResponse>
ftCursorRead
(String index, long cursor, int count) Execute the command FT.CURSOR READ.io.smallrye.mutiny.Uni<Void>
Execute the command FT.DICTADD.io.smallrye.mutiny.Uni<Void>
Execute the command FT.DICTDEL.ftDictDump
(String dict) Execute the command FT.DICTDUMP.io.smallrye.mutiny.Uni<Void>
ftDropIndex
(String index) Execute the command FT.DROPINDEX.io.smallrye.mutiny.Uni<Void>
ftDropIndex
(String index, boolean dd) Execute the command FT.DROPINDEX.io.smallrye.mutiny.Uni<SearchQueryResponse>
Execute the command FT.SEARCH.io.smallrye.mutiny.Uni<SearchQueryResponse>
Execute the command FT.SEARCH.io.smallrye.mutiny.Uni<SpellCheckResponse>
ftSpellCheck
(String index, String query) Execute the command FT.SPELLCHECK.io.smallrye.mutiny.Uni<SpellCheckResponse>
ftSpellCheck
(String index, String query, SpellCheckArgs args) Execute the command FT.SPELLCHECK.io.smallrye.mutiny.Uni<SynDumpResponse>
Execute the command FT.SYNDUMP.io.smallrye.mutiny.Uni<Void>
ftSynUpdate
(String index, String groupId, boolean skipInitialScan, String... words) Execute the command FT.SYNUPDATE.io.smallrye.mutiny.Uni<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.AbstractSearchCommands
_ft_list, _ftAggregate, _ftAggregate, _ftAliasAdd, _ftAliasDel, _ftAliasUpdate, _ftAlter, _ftCreate, _ftCursorDel, _ftCursorRead, _ftCursorRead, _ftDictAdd, _ftDictDel, _ftDictDump, _ftDropIndex, _ftDropIndex, _ftSearch, _ftSearch, _ftSpellCheck, _ftSpellCheck, _ftSynDump, _ftSynUpdate, _ftSynUpdate, _ftTagVals
Methods inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommands
execute, isMap
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.search.ReactiveSearchCommands
ftAlter
-
Field Details
-
keyType
-
-
Constructor Details
-
ReactiveSearchCommandsImpl
-
-
Method Details
-
getDataSource
- Specified by:
getDataSource
in interfaceReactiveRedisCommands
- Returns:
- the data source.
-
ft_list
Description copied from interface:ReactiveSearchCommands
Execute the command FT._LIST. Summary: Returns a list of all existing indexes. Group: searchThis is a temporary command.
- Specified by:
ft_list
in interfaceReactiveSearchCommands<K>
- Returns:
- A uni emitting the list of the keys
-
ftAggregate
public io.smallrye.mutiny.Uni<AggregationResponse> ftAggregate(String indexName, String query, AggregateArgs args) Description copied from interface:ReactiveSearchCommands
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 interfaceReactiveSearchCommands<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
-
decodeAggregateResponse
AggregationResponse decodeAggregateResponse(io.vertx.mutiny.redis.client.Response response, boolean cursor) -
ftAggregate
Description copied from interface:ReactiveSearchCommands
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 interfaceReactiveSearchCommands<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:ReactiveSearchCommands
Execute the command FT.ALIASADD. Summary: Add an alias to an index Group: search- Specified by:
ftAliasAdd
in interfaceReactiveSearchCommands<K>
- Parameters:
alias
- the alias to be added to an index.index
- the index- Returns:
- A uni emitting
null
when the operation completes
-
ftAliasDel
Description copied from interface:ReactiveSearchCommands
Execute the command FT.ALIASDEL. Summary: Remove an alias from an index Group: search- Specified by:
ftAliasDel
in interfaceReactiveSearchCommands<K>
- Parameters:
alias
- the alias to be removed- Returns:
- A uni emitting
null
when the operation completes
-
ftAliasUpdate
Description copied from interface:ReactiveSearchCommands
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 interfaceReactiveSearchCommands<K>
- Parameters:
alias
- the alias to be added to an index.index
- the index- Returns:
- A uni emitting
null
when the operation completes
-
ftAlter
public io.smallrye.mutiny.Uni<Void> ftAlter(String index, IndexedField field, boolean skipInitialScan) Description copied from interface:ReactiveSearchCommands
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 interfaceReactiveSearchCommands<K>
- Parameters:
index
- the indexfield
- the indexed field to addskipInitialScan
- whether to skip the initial scan, if set totrue
, does not scan and index.- Returns:
- A uni emitting
null
when the operation completes
-
ftCreate
Description copied from interface:ReactiveSearchCommands
Execute the command FT.CREATE. Summary: Create an index with the given specification. Group: search- Specified by:
ftCreate
in interfaceReactiveSearchCommands<K>
- Parameters:
index
- the indexargs
- the creation arguments.- Returns:
- A uni emitting
null
when the operation completes
-
ftCursorDel
Description copied from interface:ReactiveSearchCommands
Execute the command FT.CURSOR DEL. Summary: Delete a cursor Group: search- Specified by:
ftCursorDel
in interfaceReactiveSearchCommands<K>
- Parameters:
index
- the indexcursor
- the cursor id- Returns:
- A uni emitting
null
when the operation completes
-
ftCursorRead
Description copied from interface:ReactiveSearchCommands
Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search- Specified by:
ftCursorRead
in interfaceReactiveSearchCommands<K>
- Parameters:
index
- the indexcursor
- the cursor id- Returns:
- A uni emitting the aggregate response
-
ftCursorRead
public io.smallrye.mutiny.Uni<AggregationResponse> ftCursorRead(String index, long cursor, int count) Description copied from interface:ReactiveSearchCommands
Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search- Specified by:
ftCursorRead
in interfaceReactiveSearchCommands<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:ReactiveSearchCommands
Execute the command FT.DROPINDEX. Summary: Delete an index Group: search- Specified by:
ftDropIndex
in interfaceReactiveSearchCommands<K>
- Parameters:
index
- the index- Returns:
- A uni emitting
null
when the operation completes
-
ftDropIndex
Description copied from interface:ReactiveSearchCommands
Execute the command FT.DROPINDEX. Summary: Delete an index Group: search- Specified by:
ftDropIndex
in interfaceReactiveSearchCommands<K>
- Parameters:
index
- the indexdd
- drop operation that, if set, deletes the actual document hashes.- Returns:
- A uni emitting
null
when the operation completes
-
ftDictAdd
Description copied from interface:ReactiveSearchCommands
Execute the command FT.DICTADD. Summary: Add terms to a dictionary Group: search- Specified by:
ftDictAdd
in interfaceReactiveSearchCommands<K>
- Parameters:
dict
- the dictionary namewords
- the terms to add to the dictionary- Returns:
- A uni emitting
null
when the operation completes
-
ftDictDel
Description copied from interface:ReactiveSearchCommands
Execute the command FT.DICTDEL. Summary: Remove terms from a dictionary Group: search- Specified by:
ftDictDel
in interfaceReactiveSearchCommands<K>
- Parameters:
dict
- the dictionary namewords
- the terms to remove to the dictionary- Returns:
- A uni emitting
null
when the operation completes
-
ftDictDump
Description copied from interface:ReactiveSearchCommands
Execute the command FT.DICTDUMP. Summary: Dump all terms in the given dictionary Group: search- Specified by:
ftDictDump
in interfaceReactiveSearchCommands<K>
- Parameters:
dict
- the dictionary name- Returns:
- A uni emitting the list of words (terms) included in the dictionary
-
ftSearch
public io.smallrye.mutiny.Uni<SearchQueryResponse> ftSearch(String index, String query, QueryArgs args) Description copied from interface:ReactiveSearchCommands
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 interfaceReactiveSearchCommands<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:ReactiveSearchCommands
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 interfaceReactiveSearchCommands<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
-
decodeSearchQueryResult
SearchQueryResponse decodeSearchQueryResult(io.vertx.mutiny.redis.client.Response response, QueryArgs args) -
ftSpellCheck
Description copied from interface:ReactiveSearchCommands
Execute the command FT.SPELLCHECK. Summary: Perform spelling correction on a query, returning suggestions for misspelled terms Group: search- Specified by:
ftSpellCheck
in interfaceReactiveSearchCommands<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
-
decodeSpellcheckResponse
-
ftSpellCheck
public io.smallrye.mutiny.Uni<SpellCheckResponse> ftSpellCheck(String index, String query, SpellCheckArgs args) Description copied from interface:ReactiveSearchCommands
Execute the command FT.SPELLCHECK. Summary: Perform spelling correction on a query, returning suggestions for misspelled terms Group: search- Specified by:
ftSpellCheck
in interfaceReactiveSearchCommands<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:ReactiveSearchCommands
Execute the command FT.SYNDUMP. Summary: Dump the contents of a synonym group Group: search- Specified by:
ftSynDump
in interfaceReactiveSearchCommands<K>
- Parameters:
index
- the index name.- Returns:
- A uni emitting the
SynDumpResponse
-
decodeSynDumpResponse
-
ftSynUpdate
Description copied from interface:ReactiveSearchCommands
Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search- Specified by:
ftSynUpdate
in interfaceReactiveSearchCommands<K>
- Parameters:
index
- the index name.groupId
- the synonym groupwords
- the synonyms- Returns:
- A uni emitting
null
when the operation completes
-
ftSynUpdate
public io.smallrye.mutiny.Uni<Void> ftSynUpdate(String index, String groupId, boolean skipInitialScan, String... words) Description copied from interface:ReactiveSearchCommands
Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search- Specified by:
ftSynUpdate
in interfaceReactiveSearchCommands<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- Returns:
- A uni emitting
null
when the operation completes
-
ftTagVals
Description copied from interface:ReactiveSearchCommands
Execute the command FT.TAGVALS. Summary: return a distinct set of values indexed in a Tag field Group: search- Specified by:
ftTagVals
in interfaceReactiveSearchCommands<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
-