Package io.quarkus.redis.runtime.datasource

Class BlockingTransactionalSearchCommandsImpl

java.lang.Object

io.quarkus.redis.runtime.datasource.AbstractTransactionalRedisCommandGroup

io.quarkus.redis.runtime.datasource.BlockingTransactionalSearchCommandsImpl

All Implemented Interfaces:

TransactionalSearchCommands, TransactionalRedisCommands

public class BlockingTransactionalSearchCommandsImpl
extends AbstractTransactionalRedisCommandGroup
implements TransactionalSearchCommands

Field Summary

Fields inherited from class io.quarkus.redis.runtime.datasource.AbstractTransactionalRedisCommandGroup

ds, timeout

Constructor Summary

Constructors

Constructor	Description
BlockingTransactionalSearchCommandsImpl(TransactionalRedisDataSource ds, ReactiveTransactionalSearchCommands reactive, Duration timeout)

Method Summary

Modifier and Type	Method	Description
void	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.
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	ftDictAdd(String dict, String... words)	Execute the command FT.DICTADD.
void	ftDictDel(String dict, String... words)	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	ftSearch(String index, String query)	Execute the command FT.SEARCH.
void	ftSearch(String index, String query, QueryArgs args)	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	ftSynDump(String index)	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	ftTagVals(String index, String field)	Execute the command FT.TAGVALS.

Methods inherited from class io.quarkus.redis.runtime.datasource.AbstractTransactionalRedisCommandGroup

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.TransactionalRedisCommands

getDataSource

Constructor Detail

BlockingTransactionalSearchCommandsImpl

public BlockingTransactionalSearchCommandsImpl(TransactionalRedisDataSource ds,
                                               ReactiveTransactionalSearchCommands reactive,
                                               Duration timeout)

Method Detail

ft_list

public void ft_list()

Description copied from interface: TransactionalSearchCommands

Execute the command FT._LIST. Summary: Returns a list of all existing indexes. Group: search

This is a temporary command.

Specified by:

ft_list in interface TransactionalSearchCommands

ftAggregate

public void ftAggregate(String indexName,
                        String query,
                        AggregateArgs args)

Description copied from interface: TransactionalSearchCommands

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 interface TransactionalSearchCommands

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

public void ftAggregate(String indexName,
                        String query)

Description copied from interface: TransactionalSearchCommands

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 interface TransactionalSearchCommands

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

public void ftAliasAdd(String alias,
                       String index)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.ALIASADD. Summary: Add an alias to an index Group: search

Specified by:

ftAliasAdd in interface TransactionalSearchCommands

Parameters:

alias - the alias to be added to an index.

index - the index

ftAliasDel

public void ftAliasDel(String alias)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.ALIASDEL. Summary: Remove an alias from an index Group: search

Specified by:

ftAliasDel in interface TransactionalSearchCommands

Parameters:

alias - the alias to be removed

ftAliasUpdate

public void ftAliasUpdate(String alias,
                          String index)

Description copied from interface: TransactionalSearchCommands

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 interface TransactionalSearchCommands

Parameters:

alias - the alias to be added to an index.

index - the index

ftAlter

public void ftAlter(String index,
                    IndexedField field,
                    boolean skipInitialScan)

Description copied from interface: TransactionalSearchCommands

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 interface TransactionalSearchCommands

Parameters:

index - the index

field - the indexed field to add

skipInitialScan - whether to skip the initial scan, if set to true, does not scan and index.

ftAlter

public void ftAlter(String index,
                    IndexedField field)

Description copied from interface: TransactionalSearchCommands

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 interface TransactionalSearchCommands

Parameters:

index - the index

field - the indexed field to add

ftCreate

public void ftCreate(String index,
                     CreateArgs args)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.CREATE. Summary: Create an index with the given specification. Group: search

Specified by:

ftCreate in interface TransactionalSearchCommands

Parameters:

index - the index

args - the creation arguments.

ftCursorDel

public void ftCursorDel(String index,
                        long cursor)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.CURSOR DEL. Summary: Delete a cursor Group: search

Specified by:

ftCursorDel in interface TransactionalSearchCommands

Parameters:

index - the index

cursor - the cursor id

ftCursorRead

public void ftCursorRead(String index,
                         long cursor)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search

Specified by:

ftCursorRead in interface TransactionalSearchCommands

Parameters:

index - the index

cursor - the cursor id

ftCursorRead

public void ftCursorRead(String index,
                         long cursor,
                         int count)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search

Specified by:

ftCursorRead in interface TransactionalSearchCommands

Parameters:

index - the index

cursor - the cursor id

count - the number of results to read

ftDropIndex

public void ftDropIndex(String index)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.DROPINDEX. Summary: Delete an index Group: search

Specified by:

ftDropIndex in interface TransactionalSearchCommands

Parameters:

index - the index

ftDropIndex

public void ftDropIndex(String index,
                        boolean dd)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.DROPINDEX. Summary: Delete an index Group: search

Specified by:

ftDropIndex in interface TransactionalSearchCommands

Parameters:

index - the index

dd - drop operation that, if set, deletes the actual document hashes.

ftDictAdd

public void ftDictAdd(String dict,
                      String... words)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.DICTADD. Summary: Add terms to a dictionary Group: search

Specified by:

ftDictAdd in interface TransactionalSearchCommands

Parameters:

dict - the dictionary name

words - the terms to add to the dictionary

ftDictDel

public void ftDictDel(String dict,
                      String... words)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.DICTDEL. Summary: Remove terms from a dictionary Group: search

Specified by:

ftDictDel in interface TransactionalSearchCommands

Parameters:

dict - the dictionary name

words - the terms to remove to the dictionary

ftDictDump

public void ftDictDump(String dict)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.DICTDUMP. Summary: Dump all terms in the given dictionary Group: search

Specified by:

ftDictDump in interface TransactionalSearchCommands

Parameters:

dict - the dictionary name

ftSearch

public void ftSearch(String index,
                     String query,
                     QueryArgs args)

Description copied from interface: TransactionalSearchCommands

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 interface TransactionalSearchCommands

Parameters:

index - the index name. You must first create the index using FT.CREATE.

query - the text query to search.

args - the extra parameters

ftSearch

public void ftSearch(String index,
                     String query)

Description copied from interface: TransactionalSearchCommands

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 interface TransactionalSearchCommands

Parameters:

index - the index name. You must first create the index using FT.CREATE.

query - the text query to search.

ftSpellCheck

public void ftSpellCheck(String index,
                         String query)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.SPELLCHECK. Summary: Perform spelling correction on a query, returning suggestions for misspelled terms Group: search

Specified by:

ftSpellCheck in interface TransactionalSearchCommands

Parameters:

index - the index name. You must first create the index using FT.CREATE.

query - the text query to search.

ftSpellCheck

public void ftSpellCheck(String index,
                         String query,
                         SpellCheckArgs args)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.SPELLCHECK. Summary: Perform spelling correction on a query, returning suggestions for misspelled terms Group: search

Specified by:

ftSpellCheck in interface TransactionalSearchCommands

Parameters:

index - the index name. You must first create the index using FT.CREATE.

query - the text query to search.

args - the extra parameters

ftSynDump

public void ftSynDump(String index)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.SYNDUMP. Summary: Dump the contents of a synonym group Group: search

Specified by:

ftSynDump in interface TransactionalSearchCommands

Parameters:

index - the index name.

ftSynUpdate

public void ftSynUpdate(String index,
                        String groupId,
                        String... words)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search

Specified by:

ftSynUpdate in interface TransactionalSearchCommands

Parameters:

index - the index name.

groupId - the synonym group

words - the synonyms

ftSynUpdate

public void ftSynUpdate(String index,
                        String groupId,
                        boolean skipInitialScan,
                        String... words)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search

Specified by:

ftSynUpdate in interface TransactionalSearchCommands

Parameters:

index - the index name.

groupId - the synonym group

skipInitialScan - if set to true, does not scan and index, and only documents that are indexed after the update are affected.

words - the synonyms

ftTagVals

public void ftTagVals(String index,
                      String field)

Description copied from interface: TransactionalSearchCommands

Execute the command FT.TAGVALS. Summary: return a distinct set of values indexed in a Tag field Group: search

Specified by:

ftTagVals in interface TransactionalSearchCommands

Parameters:

index - the index name.

field - the name of a tag file defined in the schema.