redis.clients.jedis.search

Interface RediSearchCommands

All Known Subinterfaces:

RedisModuleCommands

All Known Implementing Classes:

JedisCluster, MultiDbClient, RedisClient, RedisClusterClient, RedisSentinelClient, UnifiedJedis

public interface RediSearchCommands

Method Summary

Modifier and Type	Method and Description
AggregationResult	ftAggregate(java.lang.String indexName, AggregationBuilder aggr) Execute an aggregation query and return all results at once.
AggregateIterator	ftAggregateIterator(java.lang.String indexName, AggregationBuilder aggr) Execute an aggregation query with cursor-based iteration support.
java.lang.String	ftAliasAdd(java.lang.String aliasName, java.lang.String indexName)
java.lang.String	ftAliasDel(java.lang.String aliasName)
java.util.Set<java.lang.String>	ftAliasList(java.lang.String indexName)
java.lang.String	ftAliasUpdate(java.lang.String aliasName, java.lang.String indexName)
java.lang.String	ftAlter(java.lang.String indexName, java.lang.Iterable<SchemaField> schemaFields)
default java.lang.String	ftAlter(java.lang.String indexName, Schema.Field... fields)
java.lang.String	ftAlter(java.lang.String indexName, Schema schema)
default java.lang.String	ftAlter(java.lang.String indexName, SchemaField... schemaFields)
java.util.Map<java.lang.String,java.lang.Object>	ftConfigGet(java.lang.String option) Deprecated. ConfigCommands.configGet(java.lang.String) is used since Redis 8.
java.util.Map<java.lang.String,java.lang.Object>	ftConfigGet(java.lang.String indexName, java.lang.String option) Deprecated.
java.lang.String	ftConfigSet(java.lang.String option, java.lang.String value) Deprecated. ConfigCommands.configSet(java.lang.String, java.lang.String) is used since Redis 8.
java.lang.String	ftConfigSet(java.lang.String indexName, java.lang.String option, java.lang.String value) Deprecated.
java.lang.String	ftCreate(java.lang.String indexName, FTCreateParams createParams, java.lang.Iterable<SchemaField> schemaFields)
default java.lang.String	ftCreate(java.lang.String indexName, FTCreateParams createParams, SchemaField... schemaFields)
java.lang.String	ftCreate(java.lang.String indexName, IndexOptions indexOptions, Schema schema)
default java.lang.String	ftCreate(java.lang.String indexName, java.lang.Iterable<SchemaField> schemaFields)
default java.lang.String	ftCreate(java.lang.String indexName, SchemaField... schemaFields)
java.lang.String	ftCursorDel(java.lang.String indexName, long cursorId) Deprecated. Use ftAggregate(String, AggregationBuilder) for operations without cursors, or ftAggregateIterator(String, AggregationBuilder) for cursor-based iteration
AggregationResult	ftCursorRead(java.lang.String indexName, long cursorId, int count) Deprecated. Use ftAggregate(String, AggregationBuilder) for operations without cursors, or ftAggregateIterator(String, AggregationBuilder) for cursor-based iteration
long	ftDictAdd(java.lang.String dictionary, java.lang.String... terms)
long	ftDictAddBySampleKey(java.lang.String indexName, java.lang.String dictionary, java.lang.String... terms)
long	ftDictDel(java.lang.String dictionary, java.lang.String... terms)
long	ftDictDelBySampleKey(java.lang.String indexName, java.lang.String dictionary, java.lang.String... terms)
java.util.Set<java.lang.String>	ftDictDump(java.lang.String dictionary)
java.util.Set<java.lang.String>	ftDictDumpBySampleKey(java.lang.String indexName, java.lang.String dictionary)
java.lang.String	ftDropIndex(java.lang.String indexName)
java.lang.String	ftDropIndexDD(java.lang.String indexName)
java.lang.String	ftExplain(java.lang.String indexName, Query query)
java.util.List<java.lang.String>	ftExplainCLI(java.lang.String indexName, Query query)
HybridResult	ftHybrid(java.lang.String indexName, FTHybridParams hybridParams) Execute a hybrid query combining text search and vector similarity.
java.util.Map<java.lang.String,java.lang.Object>	ftInfo(java.lang.String indexName)
java.util.Set<java.lang.String>	ftList()
java.util.Map.Entry<AggregationResult,ProfilingInfo>	ftProfileAggregate(java.lang.String indexName, FTProfileParams profileParams, AggregationBuilder aggr)
java.util.Map.Entry<SearchResult,ProfilingInfo>	ftProfileSearch(java.lang.String indexName, FTProfileParams profileParams, Query query)
java.util.Map.Entry<SearchResult,ProfilingInfo>	ftProfileSearch(java.lang.String indexName, FTProfileParams profileParams, java.lang.String query, FTSearchParams searchParams)
SearchResult	ftSearch(byte[] indexName, Query query) Deprecated.
default SearchResult	ftSearch(java.lang.String indexName)
SearchResult	ftSearch(java.lang.String indexName, Query query)
SearchResult	ftSearch(java.lang.String indexName, java.lang.String query)
SearchResult	ftSearch(java.lang.String indexName, java.lang.String query, FTSearchParams params)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Double>>	ftSpellCheck(java.lang.String index, java.lang.String query)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Double>>	ftSpellCheck(java.lang.String index, java.lang.String query, FTSpellCheckParams spellCheckParams)
long	ftSugAdd(java.lang.String key, java.lang.String string, double score)
long	ftSugAddIncr(java.lang.String key, java.lang.String string, double score)
boolean	ftSugDel(java.lang.String key, java.lang.String string)
java.util.List<java.lang.String>	ftSugGet(java.lang.String key, java.lang.String prefix)
java.util.List<java.lang.String>	ftSugGet(java.lang.String key, java.lang.String prefix, boolean fuzzy, int max)
java.util.List<Tuple>	ftSugGetWithScores(java.lang.String key, java.lang.String prefix)
java.util.List<Tuple>	ftSugGetWithScores(java.lang.String key, java.lang.String prefix, boolean fuzzy, int max)
long	ftSugLen(java.lang.String key)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	ftSynDump(java.lang.String indexName)
java.lang.String	ftSynUpdate(java.lang.String indexName, java.lang.String synonymGroupId, java.lang.String... terms)
java.util.Set<java.lang.String>	ftTagVals(java.lang.String indexName, java.lang.String fieldName)

Method Detail

ftCreate

java.lang.String ftCreate(java.lang.String indexName,
                          IndexOptions indexOptions,
                          Schema schema)

ftCreate

default java.lang.String ftCreate(java.lang.String indexName,
                                  SchemaField... schemaFields)

ftCreate

default java.lang.String ftCreate(java.lang.String indexName,
                                  FTCreateParams createParams,
                                  SchemaField... schemaFields)

ftCreate

default java.lang.String ftCreate(java.lang.String indexName,
                                  java.lang.Iterable<SchemaField> schemaFields)

ftCreate

java.lang.String ftCreate(java.lang.String indexName,
                          FTCreateParams createParams,
                          java.lang.Iterable<SchemaField> schemaFields)

ftAlter

default java.lang.String ftAlter(java.lang.String indexName,
                                 Schema.Field... fields)

ftAlter

java.lang.String ftAlter(java.lang.String indexName,
                         Schema schema)

ftAlter

default java.lang.String ftAlter(java.lang.String indexName,
                                 SchemaField... schemaFields)

ftAlter

java.lang.String ftAlter(java.lang.String indexName,
                         java.lang.Iterable<SchemaField> schemaFields)

ftAliasAdd

java.lang.String ftAliasAdd(java.lang.String aliasName,
                            java.lang.String indexName)

ftAliasUpdate

java.lang.String ftAliasUpdate(java.lang.String aliasName,
                               java.lang.String indexName)

ftAliasDel

java.lang.String ftAliasDel(java.lang.String aliasName)

ftAliasList

java.util.Set<java.lang.String> ftAliasList(java.lang.String indexName)

ftDropIndex

java.lang.String ftDropIndex(java.lang.String indexName)

ftDropIndexDD

java.lang.String ftDropIndexDD(java.lang.String indexName)

ftSearch

default SearchResult ftSearch(java.lang.String indexName)

ftSearch

SearchResult ftSearch(java.lang.String indexName,
                      java.lang.String query)

ftSearch

SearchResult ftSearch(java.lang.String indexName,
                      java.lang.String query,
                      FTSearchParams params)

ftSearch

SearchResult ftSearch(java.lang.String indexName,
                      Query query)

ftSearch

@Deprecated
SearchResult ftSearch(byte[] indexName,
                                  Query query)

Deprecated.

ftExplain

java.lang.String ftExplain(java.lang.String indexName,
                           Query query)

ftExplainCLI

java.util.List<java.lang.String> ftExplainCLI(java.lang.String indexName,
                                              Query query)

ftAggregate

AggregationResult ftAggregate(java.lang.String indexName,
                              AggregationBuilder aggr)

Execute an aggregation query and return all results at once. Use this method when you don't need cursor-based pagination and want to retrieve all results in a single operation.

Parameters:

indexName - the index name

aggr - the aggregation builder containing the query

Returns:

the complete aggregation result

ftAggregateIterator

AggregateIterator ftAggregateIterator(java.lang.String indexName,
                                      AggregationBuilder aggr)

Execute an aggregation query with cursor-based iteration support. Use this method when you need to paginate through large result sets or want to process results incrementally using cursor-based iteration.

Parameters:

indexName - the index name

aggr - the aggregation builder containing the query (should include cursor configuration)

Returns:

an iterator for cursor-based result pagination

ftCursorRead

@Deprecated
AggregationResult ftCursorRead(java.lang.String indexName,
                                           long cursorId,
                                           int count)

Deprecated. Use ftAggregate(String, AggregationBuilder) for operations without cursors, or ftAggregateIterator(String, AggregationBuilder) for cursor-based iteration

Read from an aggregation cursor.

Parameters:

indexName - the index name

cursorId - the cursor ID

count - the number of results to read

Returns:

the aggregation result

ftCursorDel

@Deprecated
java.lang.String ftCursorDel(java.lang.String indexName,
                                         long cursorId)

Deprecated. Use ftAggregate(String, AggregationBuilder) for operations without cursors, or ftAggregateIterator(String, AggregationBuilder) for cursor-based iteration

Delete an aggregation cursor.

Parameters:

indexName - the index name

cursorId - the cursor ID

Returns:

the result of the cursor deletion

ftProfileAggregate

java.util.Map.Entry<AggregationResult,ProfilingInfo> ftProfileAggregate(java.lang.String indexName,
                                                                        FTProfileParams profileParams,
                                                                        AggregationBuilder aggr)

ftProfileSearch

java.util.Map.Entry<SearchResult,ProfilingInfo> ftProfileSearch(java.lang.String indexName,
                                                                FTProfileParams profileParams,
                                                                Query query)

ftProfileSearch

java.util.Map.Entry<SearchResult,ProfilingInfo> ftProfileSearch(java.lang.String indexName,
                                                                FTProfileParams profileParams,
                                                                java.lang.String query,
                                                                FTSearchParams searchParams)

ftSynUpdate

java.lang.String ftSynUpdate(java.lang.String indexName,
                             java.lang.String synonymGroupId,
                             java.lang.String... terms)

ftSynDump

java.util.Map<java.lang.String,java.util.List<java.lang.String>> ftSynDump(java.lang.String indexName)

ftDictAdd

long ftDictAdd(java.lang.String dictionary,
               java.lang.String... terms)

ftDictDel

long ftDictDel(java.lang.String dictionary,
               java.lang.String... terms)

ftDictDump

java.util.Set<java.lang.String> ftDictDump(java.lang.String dictionary)

ftDictAddBySampleKey

long ftDictAddBySampleKey(java.lang.String indexName,
                          java.lang.String dictionary,
                          java.lang.String... terms)

ftDictDelBySampleKey

long ftDictDelBySampleKey(java.lang.String indexName,
                          java.lang.String dictionary,
                          java.lang.String... terms)

ftDictDumpBySampleKey

java.util.Set<java.lang.String> ftDictDumpBySampleKey(java.lang.String indexName,
                                                      java.lang.String dictionary)

ftSpellCheck

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Double>> ftSpellCheck(java.lang.String index,
                                                                                              java.lang.String query)

ftSpellCheck

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Double>> ftSpellCheck(java.lang.String index,
                                                                                              java.lang.String query,
                                                                                              FTSpellCheckParams spellCheckParams)

ftInfo

java.util.Map<java.lang.String,java.lang.Object> ftInfo(java.lang.String indexName)

ftTagVals

java.util.Set<java.lang.String> ftTagVals(java.lang.String indexName,
                                          java.lang.String fieldName)

ftConfigGet

@Deprecated
java.util.Map<java.lang.String,java.lang.Object> ftConfigGet(java.lang.String option)

Deprecated. ConfigCommands.configGet(java.lang.String) is used since Redis 8.

ftConfigGet

@Deprecated
java.util.Map<java.lang.String,java.lang.Object> ftConfigGet(java.lang.String indexName,
                                                                         java.lang.String option)

Deprecated.

ftConfigSet

@Deprecated
java.lang.String ftConfigSet(java.lang.String option,
                                         java.lang.String value)

Deprecated. ConfigCommands.configSet(java.lang.String, java.lang.String) is used since Redis 8.

ftConfigSet

@Deprecated
java.lang.String ftConfigSet(java.lang.String indexName,
                                         java.lang.String option,
                                         java.lang.String value)

Deprecated.

ftSugAdd

long ftSugAdd(java.lang.String key,
              java.lang.String string,
              double score)

ftSugAddIncr

long ftSugAddIncr(java.lang.String key,
                  java.lang.String string,
                  double score)

ftSugGet

java.util.List<java.lang.String> ftSugGet(java.lang.String key,
                                          java.lang.String prefix)

ftSugGet

java.util.List<java.lang.String> ftSugGet(java.lang.String key,
                                          java.lang.String prefix,
                                          boolean fuzzy,
                                          int max)

ftSugGetWithScores

java.util.List<Tuple> ftSugGetWithScores(java.lang.String key,
                                         java.lang.String prefix)

ftSugGetWithScores

java.util.List<Tuple> ftSugGetWithScores(java.lang.String key,
                                         java.lang.String prefix,
                                         boolean fuzzy,
                                         int max)

ftSugDel

boolean ftSugDel(java.lang.String key,
                 java.lang.String string)

ftSugLen

long ftSugLen(java.lang.String key)

ftList

java.util.Set<java.lang.String> ftList()

ftHybrid

@Experimental
HybridResult ftHybrid(java.lang.String indexName,
                                    FTHybridParams hybridParams)

Execute a hybrid query combining text search and vector similarity.

Parameters:

indexName - the index name

hybridParams - the hybrid query arguments

Returns:

the hybrid search results

See Also:

FTHybridParams, HybridResult