Interface TransactionalSearchCommands
- All Superinterfaces:
TransactionalRedisCommands
- All Known Implementing Classes:
BlockingTransactionalSearchCommandsImpl
@Experimental("The commands from the search group are experimental")
public interface TransactionalSearchCommands
extends TransactionalRedisCommands
Allows executing commands from the
search
group (requires the Redis Search module from Redis stack).
See the search command list for further information about these
commands.
<a href="https://redis.io/docs/stack/search/"Redis Search allows querying, secondary indexing, and full-text search for Redis.
This API is intended to be used in a Redis transaction (MULTI
), thus, all command methods return void
.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
ft_list()
Execute the command FT._LIST.void
ftAggregate
(String indexName, String query) Execute the command FT.AGGREGATE.void
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.default void
ftAlter
(String index, IndexedField field) Execute the command FT.ALTER.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.void
ftCursorRead
(String index, long cursor) Execute the command FT.CURSOR READ.void
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.void
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.void
Execute the command FT.SEARCH.void
Execute the command FT.SEARCH.void
ftSpellCheck
(String index, String query) Execute the command FT.SPELLCHECK.void
ftSpellCheck
(String index, String query, SpellCheckArgs args) Execute the command FT.SPELLCHECK.void
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.void
Execute the command FT.TAGVALS.Methods inherited from interface io.quarkus.redis.datasource.TransactionalRedisCommands
getDataSource
-
Method Details
-
ft_list
void ft_list()Execute the command FT._LIST. Summary: Returns a list of all existing indexes. Group: searchThis is a temporary command.
-
ftAggregate
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- 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
-
ftAggregate
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- 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.
-
ftAliasAdd
Execute the command FT.ALIASADD. Summary: Add an alias to an index Group: search- Parameters:
alias
- the alias to be added to an index.index
- the index
-
ftAliasDel
Execute the command FT.ALIASDEL. Summary: Remove an alias from an index Group: search- Parameters:
alias
- the alias to be removed
-
ftAliasUpdate
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- Parameters:
alias
- the alias to be added to an index.index
- the index
-
ftAlter
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- Parameters:
index
- the indexfield
- the indexed field to addskipInitialScan
- whether to skip the initial scan, if set totrue
, does not scan and index.
-
ftAlter
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- Parameters:
index
- the indexfield
- the indexed field to add
-
ftCreate
Execute the command FT.CREATE. Summary: Create an index with the given specification. Group: search- Parameters:
index
- the indexargs
- the creation arguments.
-
ftCursorDel
Execute the command FT.CURSOR DEL. Summary: Delete a cursor Group: search- Parameters:
index
- the indexcursor
- the cursor id
-
ftCursorRead
Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search- Parameters:
index
- the indexcursor
- the cursor id
-
ftCursorRead
Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search- Parameters:
index
- the indexcursor
- the cursor idcount
- the number of results to read
-
ftDropIndex
Execute the command FT.DROPINDEX. Summary: Delete an index Group: search- Parameters:
index
- the index
-
ftDropIndex
Execute the command FT.DROPINDEX. Summary: Delete an index Group: search- Parameters:
index
- the indexdd
- drop operation that, if set, deletes the actual document hashes.
-
ftDictAdd
Execute the command FT.DICTADD. Summary: Add terms to a dictionary Group: search- Parameters:
dict
- the dictionary namewords
- the terms to add to the dictionary
-
ftDictDel
Execute the command FT.DICTDEL. Summary: Remove terms from a dictionary Group: search- Parameters:
dict
- the dictionary namewords
- the terms to remove to the dictionary
-
ftDictDump
Execute the command FT.DICTDUMP. Summary: Dump all terms in the given dictionary Group: search- Parameters:
dict
- the dictionary name
-
ftSearch
Execute the command FT.SEARCH. Summary: Search the index with a textual query, returning either documents or just ids Group: search- Parameters:
index
- the index name. You must first create the index usingFT.CREATE
.query
- the text query to search.args
- the extra parameters
-
ftSearch
Execute the command FT.SEARCH. Summary: Search the index with a textual query, returning either documents or just ids Group: search- Parameters:
index
- the index name. You must first create the index usingFT.CREATE
.query
- the text query to search.
-
ftSpellCheck
Execute the command FT.SPELLCHECK. Summary: Perform spelling correction on a query, returning suggestions for misspelled terms Group: search- Parameters:
index
- the index name. You must first create the index usingFT.CREATE
.query
- the text query to search.
-
ftSpellCheck
Execute the command FT.SPELLCHECK. Summary: Perform spelling correction on a query, returning suggestions for misspelled terms Group: search- Parameters:
index
- the index name. You must first create the index usingFT.CREATE
.query
- the text query to search.args
- the extra parameters
-
ftSynDump
Execute the command FT.SYNDUMP. Summary: Dump the contents of a synonym group Group: search- Parameters:
index
- the index name.
-
ftSynUpdate
Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search- Parameters:
index
- the index name.groupId
- the synonym groupwords
- the synonyms
-
ftSynUpdate
Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search- 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
Execute the command FT.TAGVALS. Summary: return a distinct set of values indexed in a Tag field Group: search- Parameters:
index
- the index name.field
- the name of a tag file defined in the schema.
-