io.lettuce.core.search

Class SearchReplyParser<K,V>

java.lang.Object

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

Type Parameters:

K - the type of keys used in the search results

V - the type of values used in the search results

All Implemented Interfaces:

ComplexDataParser<SearchReply<K,V>>

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

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
• Cursor-based pagination for large result sets
• Warning messages from Redis
• Total result counts

Since:

6.8

Author:

Redis Ltd.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SearchReply<K,V>	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,V> codec,
                         SearchArgs<K,V> 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 encoding/decoding keys and values. 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.isNoContent() is true, document content will be excluded from parsing
• Document IDs are always parsed when using this constructor

SearchReplyParser

public SearchReplyParser(RedisCodec<K,V> 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)
• Content is parsed (withContent = true)
• IDs are not parsed (withIds = false)

Parameters:

codec - the Redis codec used for encoding/decoding keys and values. Must not be null.

Method Detail

parse

public SearchReply<K,V> 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,V>>

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.