io.lettuce.core.search

Class SearchReplyParser<K>

java.lang.Object

io.lettuce.core.search.SearchReplyParser<K>

Type Parameters:

K - the type of the document id in the search results

All Implemented Interfaces:

ComplexDataParser<SearchReply<K>>

public class SearchReplyParser<K>
extends Object
implements ComplexDataParser<SearchReply<K>>

Parser for Redis Search (RediSearch) command responses that converts raw Redis data into structured SearchReply objects. This parser handles both RESP2 and RESP3 protocol responses and supports various search result formats including results with scores, content, IDs, and cursor-based pagination.

The parser automatically detects the Redis protocol version and switches between RESP2 and RESP3 parsing strategies. It supports the following search result features:

• Document IDs and content fields
• Search scores when requested with WITHSCORES
• Sort keys when requested with WITHSORTKEYS
• Cursor-based pagination for large result sets
• Warning messages from Redis
• Total result counts

Document ids are decoded through the connection's key codec; rows that carry no id (FT.AGGREGATE and FT.CURSOR READ) get a null id. Field names are schema identifiers (hash field names, JSONPath expressions or aliases) and are decoded as raw UTF-8; field values are kept as raw bytes so that binary content (for example vector embeddings) survives the round-trip. Nested field values produced by aggregation reducers (for example REDUCE COLLECT) are converted recursively into FieldValue arrays and maps. Sort keys are decoded as UTF-8 text exactly as serialized by the server (see SearchReply.SearchResult.getSortKey()).

Since:

6.8

Author:

Redis Ltd.

Constructor Summary

Constructors

Constructor and Description
SearchReplyParser(RedisCodec<K,?> codec) Creates a new SearchReplyParser with default parsing configuration.
SearchReplyParser(RedisCodec<K,?> codec, SearchArgs<K> args) Creates a new SearchReplyParser configured based on the provided search arguments.

Method Summary

Modifier and Type	Method and Description
SearchReply<K>	parse(ComplexData data) Parses Redis Search command response data into a structured SearchReply object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchReplyParser

public SearchReplyParser(RedisCodec<K,?> codec,
                         SearchArgs<K> args)

Creates a new SearchReplyParser configured based on the provided search arguments. This constructor analyzes the search arguments to determine which components of the search results should be parsed and included in the final SearchReply.

Parameters:

codec - the Redis codec used for decoding document ids. Must not be null.

args - the search arguments that determine parsing behavior. If null, default parsing behavior is used (with content, without scores, with IDs).

• If args.isWithScores() is true, search scores will be parsed and included
• If args.isWithSortKeys() is true, sort keys will be parsed and included
• If args.isNoContent() is true, document content will be excluded from parsing
• Document IDs are always parsed when using this constructor

SearchReplyParser

public SearchReplyParser(RedisCodec<K,?> codec)

Creates a new SearchReplyParser with default parsing configuration. This constructor is typically used for aggregation results or other search operations where specific search arguments are not available.

Default configuration:

• Scores are not parsed (withScores = false)
• Sort keys are not parsed (withSortKeys = false)
• Content is parsed (withContent = true)
• IDs are not parsed (withIds = false); every parsed row has a null id

Parameters:

codec - the Redis codec used for decoding document ids. Must not be null.

Method Detail

parse

public SearchReply<K> parse(ComplexData data)

Parses Redis Search command response data into a structured SearchReply object. This method automatically detects the Redis protocol version (RESP2 or RESP3) and uses the appropriate parsing strategy.

Specified by:

parse in interface ComplexDataParser<SearchReply<K>>

Parameters:

data - the complex data structure returned by Redis containing the search results. Must not be null.

Returns:

a SearchReply containing the parsed search results. Never null. Returns an empty SearchReply if parsing fails.