Package io.quarkus.redis.datasource.search

Interface ReactiveTransactionalSearchCommands

All Superinterfaces:
ReactiveTransactionalRedisCommands
All Known Implementing Classes:
ReactiveTransactionalSearchCommandsImpl
@Experimental("The commands from the search group are experimental") public interface ReactiveTransactionalSearchCommands extends ReactiveTransactionalRedisCommands
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 Uni<Void>.

  • Method Details

    • ft_list

      io.smallrye.mutiny.Uni<Void> ft_list()
      Execute the command FT._LIST. Summary: Returns a list of all existing indexes. Group: search

      This is a temporary command.

      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftAggregate

      io.smallrye.mutiny.Uni<Void> ftAggregate(String indexName, String query, AggregateArgs args)
      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
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftAggregate

      io.smallrye.mutiny.Uni<Void> ftAggregate(String indexName, String query)
      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.
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftAliasAdd

      io.smallrye.mutiny.Uni<Void> ftAliasAdd(String alias, String index)
      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
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftAliasDel

      io.smallrye.mutiny.Uni<Void> ftAliasDel(String alias)
      Execute the command FT.ALIASDEL. Summary: Remove an alias from an index Group: search
      Parameters:
      alias - the alias to be removed
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftAliasUpdate

      io.smallrye.mutiny.Uni<Void> ftAliasUpdate(String alias, String index)
      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
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftAlter

      io.smallrye.mutiny.Uni<Void> ftAlter(String index, IndexedField field, boolean skipInitialScan)
      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 index
      field - the indexed field to add
      skipInitialScan - whether to skip the initial scan, if set to true, does not scan and index.
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftAlter

      default io.smallrye.mutiny.Uni<Void> ftAlter(String index, IndexedField field)
      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 index
      field - the indexed field to add
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftCreate

      io.smallrye.mutiny.Uni<Void> ftCreate(String index, CreateArgs args)
      Execute the command FT.CREATE. Summary: Create an index with the given specification. Group: search
      Parameters:
      index - the index
      args - the creation arguments.
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftCursorDel

      io.smallrye.mutiny.Uni<Void> ftCursorDel(String index, long cursor)
      Execute the command FT.CURSOR DEL. Summary: Delete a cursor Group: search
      Parameters:
      index - the index
      cursor - the cursor id
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftCursorRead

      io.smallrye.mutiny.Uni<Void> ftCursorRead(String index, long cursor)
      Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search
      Parameters:
      index - the index
      cursor - the cursor id
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftCursorRead

      io.smallrye.mutiny.Uni<Void> ftCursorRead(String index, long cursor, int count)
      Execute the command FT.CURSOR READ. Summary: Read next results from an existing cursor Group: search
      Parameters:
      index - the index
      cursor - the cursor id
      count - the number of results to read
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftDropIndex

      io.smallrye.mutiny.Uni<Void> ftDropIndex(String index)
      Execute the command FT.DROPINDEX. Summary: Delete an index Group: search
      Parameters:
      index - the index
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftDropIndex

      io.smallrye.mutiny.Uni<Void> ftDropIndex(String index, boolean dd)
      Execute the command FT.DROPINDEX. Summary: Delete an index Group: search
      Parameters:
      index - the index
      dd - drop operation that, if set, deletes the actual document hashes.
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftDictAdd

      io.smallrye.mutiny.Uni<Void> ftDictAdd(String dict, String... words)
      Execute the command FT.DICTADD. Summary: Add terms to a dictionary Group: search
      Parameters:
      dict - the dictionary name
      words - the terms to add to the dictionary
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftDictDel

      io.smallrye.mutiny.Uni<Void> ftDictDel(String dict, String... words)
      Execute the command FT.DICTDEL. Summary: Remove terms from a dictionary Group: search
      Parameters:
      dict - the dictionary name
      words - the terms to remove to the dictionary
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftDictDump

      io.smallrye.mutiny.Uni<Void> ftDictDump(String dict)
      Execute the command FT.DICTDUMP. Summary: Dump all terms in the given dictionary Group: search
      Parameters:
      dict - the dictionary name
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftSearch

      io.smallrye.mutiny.Uni<Void> ftSearch(String index, String query, QueryArgs args)
      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 using FT.CREATE.
      query - the text query to search.
      args - the extra parameters
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftSearch

      io.smallrye.mutiny.Uni<Void> ftSearch(String index, String query)
      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 using FT.CREATE.
      query - the text query to search.
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftSpellCheck

      io.smallrye.mutiny.Uni<Void> ftSpellCheck(String index, String query)
      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 using FT.CREATE.
      query - the text query to search.
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftSpellCheck

      io.smallrye.mutiny.Uni<Void> ftSpellCheck(String index, String query, SpellCheckArgs args)
      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 using FT.CREATE.
      query - the text query to search.
      args - the extra parameters
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftSynDump

      io.smallrye.mutiny.Uni<Void> ftSynDump(String index)
      Execute the command FT.SYNDUMP. Summary: Dump the contents of a synonym group Group: search
      Parameters:
      index - the index name.
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftSynUpdate

      io.smallrye.mutiny.Uni<Void> ftSynUpdate(String index, String groupId, String... words)
      Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search
      Parameters:
      index - the index name.
      groupId - the synonym group
      words - the synonyms
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftSynUpdate

      io.smallrye.mutiny.Uni<Void> ftSynUpdate(String index, String groupId, boolean skipInitialScan, String... words)
      Execute the command FT.SYNUPDATE. Summary: Update a synonym group Group: search
      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
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.

    • ftTagVals

      io.smallrye.mutiny.Uni<Void> ftTagVals(String index, String field)
      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.
      Returns:
      A Uni emitting null when the command has been enqueued successfully in the transaction, a failure otherwise. In the case of failure, the transaction is discarded.