io.lettuce.core.search

Class SearchReply<K,V>

java.lang.Object

io.lettuce.core.search.SearchReply<K,V>

Type Parameters:

K - Key type.

V - Value type.

public class SearchReply<K,V>
extends Object

Represents the results of a Redis FT.SEARCH command.

This class encapsulates the search results including the total count of matching documents and a list of individual search result documents. Each document contains the document ID and optionally the document fields, score, payload, and sort keys depending on the search arguments used.

Since:

6.8

Author:

Tihomir Mateev

See Also:

FT.SEARCH

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchReply.SearchResult<K,V> Represents a single search result document.

Constructor Summary

Constructors

Constructor and Description
SearchReply() Creates a new empty SearchReply instance.

Method Summary

Modifier and Type	Method and Description
void	addResult(SearchReply.SearchResult<K,V> result) Adds a search result document to the results list.
long	getCount() Gets the total number of matching documents.
Long	getCursorId() Gets the cursor ID for paginated results.
List<SearchReply.SearchResult<K,V>>	getResults() Gets the list of search result documents.
List<V>	getWarnings()
boolean	isEmpty() Checks if the search results are empty.
int	size() Gets the number of search result documents returned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchReply

public SearchReply()

Creates a new empty SearchReply instance.

Method Detail

getCount

public long getCount()

Gets the total number of matching documents.

This represents the total count of documents that match the search query, which may be larger than the number of results returned if LIMIT was used.

Returns:

the total number of matching documents

getResults

public List<SearchReply.SearchResult<K,V>> getResults()

Gets the list of search result documents.

Each result contains the document ID and optionally the document fields, score, payload, and sort keys depending on the search arguments used.

Returns:

an unmodifiable list of search result documents

addResult

public void addResult(SearchReply.SearchResult<K,V> result)

Adds a search result document to the results list.

Parameters:

result - the search result document to add

size

public int size()

Gets the number of search result documents returned.

This may be different from getCount() if LIMIT was used in the search.

Returns:

the number of search result documents returned

isEmpty

public boolean isEmpty()

Checks if the search results are empty.

Returns:

true if no search result documents were returned, false otherwise

getCursorId

public Long getCursorId()

Gets the cursor ID for paginated results.

This is only available when using cursor-based pagination with FT.AGGREGATE WITHCURSOR. A cursor ID of 0 indicates that there are no more results to fetch.

Returns:

the cursor ID, or null if cursor-based pagination is not being used

getWarnings

public List<V> getWarnings()

Returns:

a List of all the warnings generated during the execution of this search