| Package | Description |
|---|---|
| io.lettuce.core |
The Redis client package containing
RedisClient for Redis Standalone and Redis Sentinel operations. |
| io.lettuce.core.api |
Standalone Redis connection API.
|
| io.lettuce.core.api.async |
Standalone Redis API for asynchronous executed commands.
|
| io.lettuce.core.api.reactive |
Standalone Redis API for reactive command execution.
|
| io.lettuce.core.api.sync |
Standalone Redis API for synchronous executed commands.
|
| io.lettuce.core.cluster.api.async |
Redis Cluster API for asynchronous executed commands.
|
| io.lettuce.core.cluster.api.sync |
Redis Cluster API for synchronous executed commands.
|
| io.lettuce.core.failover | |
| io.lettuce.core.failover.api | |
| io.lettuce.core.failover.health | |
| io.lettuce.core.failover.metrics | |
| io.lettuce.core.search |
Support for the RediSearch features.
|
| io.lettuce.core.search.arguments |
| Modifier and Type | Class and Description |
|---|---|
class |
CompareCondition<V>
A compare condition to be used with commands that support conditional value checks (e.g.
|
interface |
Delegating<T>
A delegating interface that allows access to the underlying delegate.
|
| Modifier and Type | Method and Description |
|---|---|
static SetArgs |
SetArgs.Builder.compareCondition(CompareCondition condition)
Creates new
SetArgs with compare condition CompareCondition |
<V> SetArgs |
SetArgs.compareCondition(CompareCondition<V> compareCondition)
Set a compare condition for the SET operation.
|
protected DefaultEndpoint |
RedisClient.createEndpoint()
Create a new
DefaultEndpoint. |
protected <K,V> PubSubEndpoint<K,V> |
RedisClient.createPubSubEndpoint()
Create a new
PubSubEndpoint. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
BaseRedisClient |
| Modifier and Type | Method and Description |
|---|---|
RedisFuture<Long> |
RedisKeyAsyncCommands.delex(K key,
CompareCondition<V> compareCondition)
Delete the specified key if the compare condition matches.
|
RedisFuture<String> |
RedisKeyAsyncCommands.digestKey(K key)
Return the XXH3 64-bit digest of the string value stored at a key as a 16-character hex string.
|
RedisFuture<AggregationReply<K,V>> |
RediSearchAsyncCommands.ftAggregate(String index,
V query)
Run a search query on an index and perform basic aggregate transformations using default options.
|
RedisFuture<AggregationReply<K,V>> |
RediSearchAsyncCommands.ftAggregate(String index,
V query,
AggregateArgs<K,V> args)
Run a search query on an index and perform advanced aggregate transformations with a processing pipeline.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftAliasadd(String alias,
String index)
Add an alias to a search index.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftAliasdel(String alias)
Remove an alias from a search index.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftAliasupdate(String alias,
String index)
Update an existing alias to point to a different search index.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftAlter(String index,
boolean skipInitialScan,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftAlter(String index,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftCreate(String index,
CreateArgs<K,V> arguments,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name, custom configuration, and field definitions.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftCreate(String index,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name and field definitions using default settings.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftCursordel(String index,
AggregationReply.Cursor cursor)
Delete a cursor and free its associated resources.
|
RedisFuture<AggregationReply<K,V>> |
RediSearchAsyncCommands.ftCursorread(String index,
AggregationReply.Cursor cursor)
Read next results from an existing cursor using the default batch size.
|
RedisFuture<AggregationReply<K,V>> |
RediSearchAsyncCommands.ftCursorread(String index,
AggregationReply.Cursor cursor,
int count)
Read next results from an existing cursor and optionally override the batch size.
|
RedisFuture<Long> |
RediSearchAsyncCommands.ftDictadd(String dict,
V... terms)
Add terms to a dictionary.
|
RedisFuture<Long> |
RediSearchAsyncCommands.ftDictdel(String dict,
V... terms)
Delete terms from a dictionary.
|
RedisFuture<List<V>> |
RediSearchAsyncCommands.ftDictdump(String dict)
Dump all terms in a dictionary.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftDropindex(String index)
Drop a search index without deleting the associated documents.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftDropindex(String index,
boolean deleteDocuments)
Drop a search index with optional document deletion.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftExplain(String index,
V query)
Return the execution plan for a complex query.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftExplain(String index,
V query,
ExplainArgs<K,V> args)
Return the execution plan for a complex query with additional options.
|
RedisFuture<HybridReply<K,V>> |
RediSearchAsyncCommands.ftHybrid(String index,
HybridArgs<K,V> args)
Execute a hybrid query combining text search and vector similarity.
|
RedisFuture<List<V>> |
RediSearchAsyncCommands.ftList()
Return a list of all existing indexes.
|
RedisFuture<SearchReply<K,V>> |
RediSearchAsyncCommands.ftSearch(String index,
V query)
Search the index with a textual query using default search options.
|
RedisFuture<SearchReply<K,V>> |
RediSearchAsyncCommands.ftSearch(String index,
V query,
SearchArgs<K,V> args)
Search the index with a textual query using advanced search options and filters.
|
RedisFuture<SpellCheckResult<V>> |
RediSearchAsyncCommands.ftSpellcheck(String index,
V query)
Perform spelling correction on a query, returning suggestions for misspelled terms.
|
RedisFuture<SpellCheckResult<V>> |
RediSearchAsyncCommands.ftSpellcheck(String index,
V query,
SpellCheckArgs<K,V> args)
Perform spelling correction on a query with additional options.
|
RedisFuture<Long> |
RediSearchAsyncCommands.ftSugadd(K key,
V suggestion,
double score)
Add a suggestion string to an auto-complete suggestion dictionary.
|
RedisFuture<Long> |
RediSearchAsyncCommands.ftSugadd(K key,
V suggestion,
double score,
SugAddArgs<K,V> args)
Add a suggestion string to an auto-complete suggestion dictionary with additional options.
|
RedisFuture<Boolean> |
RediSearchAsyncCommands.ftSugdel(K key,
V suggestion)
Delete a string from a suggestion dictionary.
|
RedisFuture<List<Suggestion<V>>> |
RediSearchAsyncCommands.ftSugget(K key,
V prefix)
Get completion suggestions for a prefix.
|
RedisFuture<List<Suggestion<V>>> |
RediSearchAsyncCommands.ftSugget(K key,
V prefix,
SugGetArgs<K,V> args)
Get completion suggestions for a prefix with additional options.
|
RedisFuture<Long> |
RediSearchAsyncCommands.ftSuglen(K key)
Get the size of an auto-complete suggestion dictionary.
|
RedisFuture<Map<V,List<V>>> |
RediSearchAsyncCommands.ftSyndump(String index)
Dump synonym group contents.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftSynupdate(String index,
V synonymGroupId,
SynUpdateArgs<K,V> args,
V... terms)
Update a synonym group with additional terms and options.
|
RedisFuture<String> |
RediSearchAsyncCommands.ftSynupdate(String index,
V synonymGroupId,
V... terms)
Update a synonym group with additional terms.
|
RedisFuture<List<V>> |
RediSearchAsyncCommands.ftTagvals(String index,
String fieldName)
Return a distinct set of values indexed in a Tag field.
|
RedisFuture<Boolean> |
RedisVectorSetAsyncCommands.vadd(K key,
int dimensionality,
V element,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality. |
RedisFuture<Boolean> |
RedisVectorSetAsyncCommands.vadd(K key,
int dimensionality,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality and additional options. |
RedisFuture<Boolean> |
RedisVectorSetAsyncCommands.vadd(K key,
V element,
Double... vectors)
Add a new element into the vector set specified by
key. |
RedisFuture<Boolean> |
RedisVectorSetAsyncCommands.vadd(K key,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with additional options. |
RedisFuture<Long> |
RedisVectorSetAsyncCommands.vcard(K key)
Returns the number of elements in the vector set stored at
key. |
RedisFuture<Boolean> |
RedisVectorSetAsyncCommands.vClearAttributes(K key,
V element)
Clears all attributes for the specified
element in the vector set stored at key. |
RedisFuture<Long> |
RedisVectorSetAsyncCommands.vdim(K key)
Returns the dimensionality of the vector set stored at
key. |
RedisFuture<List<Double>> |
RedisVectorSetAsyncCommands.vemb(K key,
V element)
Returns the approximate vector associated with a given
element in the vector set stored at key. |
RedisFuture<RawVector> |
RedisVectorSetAsyncCommands.vembRaw(K key,
V element)
Returns the raw vector data for the specified
element in the vector set stored at key. |
RedisFuture<String> |
RedisVectorSetAsyncCommands.vgetattr(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
RedisFuture<List<JsonValue>> |
RedisVectorSetAsyncCommands.vgetattrAsJsonValue(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
RedisFuture<VectorMetadata> |
RedisVectorSetAsyncCommands.vinfo(K key)
Returns metadata and internal details about the vector set stored at
key. |
RedisFuture<List<V>> |
RedisVectorSetAsyncCommands.vlinks(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph of the vector set stored at key. |
RedisFuture<Map<V,Double>> |
RedisVectorSetAsyncCommands.vlinksWithScores(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph along with their scores. |
RedisFuture<V> |
RedisVectorSetAsyncCommands.vrandmember(K key)
Returns a random element from the vector set stored at
key. |
RedisFuture<List<V>> |
RedisVectorSetAsyncCommands.vrandmember(K key,
int count)
Returns multiple random elements from the vector set stored at
key. |
RedisFuture<Boolean> |
RedisVectorSetAsyncCommands.vrem(K key,
V element)
Removes the specified
element from the vector set stored at key. |
RedisFuture<Boolean> |
RedisVectorSetAsyncCommands.vsetattr(K key,
V element,
JsonValue json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
RedisFuture<Boolean> |
RedisVectorSetAsyncCommands.vsetattr(K key,
V element,
String json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
RedisFuture<List<V>> |
RedisVectorSetAsyncCommands.vsim(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key. |
RedisFuture<List<V>> |
RedisVectorSetAsyncCommands.vsim(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key. |
RedisFuture<List<V>> |
RedisVectorSetAsyncCommands.vsim(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options. |
RedisFuture<List<V>> |
RedisVectorSetAsyncCommands.vsim(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options. |
RedisFuture<Map<V,Double>> |
RedisVectorSetAsyncCommands.vsimWithScore(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores. |
RedisFuture<Map<V,Double>> |
RedisVectorSetAsyncCommands.vsimWithScore(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores. |
RedisFuture<Map<V,Double>> |
RedisVectorSetAsyncCommands.vsimWithScore(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores. |
RedisFuture<Map<V,Double>> |
RedisVectorSetAsyncCommands.vsimWithScore(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores. |
RedisFuture<Map<V,VSimScoreAttribs>> |
RedisVectorSetAsyncCommands.vsimWithScoreWithAttribs(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores and attributes. |
RedisFuture<Map<V,VSimScoreAttribs>> |
RedisVectorSetAsyncCommands.vsimWithScoreWithAttribs(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores and attributes. |
RedisFuture<Map<V,VSimScoreAttribs>> |
RedisVectorSetAsyncCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores and attributes. |
RedisFuture<Map<V,VSimScoreAttribs>> |
RedisVectorSetAsyncCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores and attributes. |
| Modifier and Type | Method and Description |
|---|---|
Mono<Long> |
RedisKeyReactiveCommands.delex(K key,
CompareCondition<V> compareCondition)
Delete the specified key if the compare condition matches.
|
Mono<String> |
RedisKeyReactiveCommands.digestKey(K key)
Return the XXH3 64-bit digest of the string value stored at a key as a 16-character hex string.
|
Mono<AggregationReply<K,V>> |
RediSearchReactiveCommands.ftAggregate(String index,
V query)
Run a search query on an index and perform basic aggregate transformations using default options.
|
Mono<AggregationReply<K,V>> |
RediSearchReactiveCommands.ftAggregate(String index,
V query,
AggregateArgs<K,V> args)
Run a search query on an index and perform advanced aggregate transformations with a processing pipeline.
|
Mono<String> |
RediSearchReactiveCommands.ftAliasadd(String alias,
String index)
Add an alias to a search index.
|
Mono<String> |
RediSearchReactiveCommands.ftAliasdel(String alias)
Remove an alias from a search index.
|
Mono<String> |
RediSearchReactiveCommands.ftAliasupdate(String alias,
String index)
Update an existing alias to point to a different search index.
|
Mono<String> |
RediSearchReactiveCommands.ftAlter(String index,
boolean skipInitialScan,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
Mono<String> |
RediSearchReactiveCommands.ftAlter(String index,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
Mono<String> |
RediSearchReactiveCommands.ftCreate(String index,
CreateArgs<K,V> arguments,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name, custom configuration, and field definitions.
|
Mono<String> |
RediSearchReactiveCommands.ftCreate(String index,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name and field definitions using default settings.
|
Mono<String> |
RediSearchReactiveCommands.ftCursordel(String index,
AggregationReply.Cursor cursor)
Delete a cursor and free its associated resources.
|
Mono<AggregationReply<K,V>> |
RediSearchReactiveCommands.ftCursorread(String index,
AggregationReply.Cursor cursor)
Read next results from an existing cursor using the default batch size.
|
Mono<AggregationReply<K,V>> |
RediSearchReactiveCommands.ftCursorread(String index,
AggregationReply.Cursor cursor,
int count)
Read next results from an existing cursor and optionally override the batch size.
|
Mono<Long> |
RediSearchReactiveCommands.ftDictadd(String dict,
V... terms)
Add terms to a dictionary.
|
Mono<Long> |
RediSearchReactiveCommands.ftDictdel(String dict,
V... terms)
Delete terms from a dictionary.
|
Flux<V> |
RediSearchReactiveCommands.ftDictdump(String dict)
Dump all terms in a dictionary.
|
Mono<String> |
RediSearchReactiveCommands.ftDropindex(String index)
Drop a search index without deleting the associated documents.
|
Mono<String> |
RediSearchReactiveCommands.ftDropindex(String index,
boolean deleteDocuments)
Drop a search index with optional document deletion.
|
Mono<String> |
RediSearchReactiveCommands.ftExplain(String index,
V query)
Return the execution plan for a complex query.
|
Mono<String> |
RediSearchReactiveCommands.ftExplain(String index,
V query,
ExplainArgs<K,V> args)
Return the execution plan for a complex query with additional options.
|
Mono<HybridReply<K,V>> |
RediSearchReactiveCommands.ftHybrid(String index,
HybridArgs<K,V> args)
Execute a hybrid query combining text search and vector similarity.
|
Flux<V> |
RediSearchReactiveCommands.ftList()
Return a list of all existing indexes.
|
Mono<SearchReply<K,V>> |
RediSearchReactiveCommands.ftSearch(String index,
V query)
Search the index with a textual query using default search options.
|
Mono<SearchReply<K,V>> |
RediSearchReactiveCommands.ftSearch(String index,
V query,
SearchArgs<K,V> args)
Search the index with a textual query using advanced search options and filters.
|
Mono<SpellCheckResult<V>> |
RediSearchReactiveCommands.ftSpellcheck(String index,
V query)
Perform spelling correction on a query, returning suggestions for misspelled terms.
|
Mono<SpellCheckResult<V>> |
RediSearchReactiveCommands.ftSpellcheck(String index,
V query,
SpellCheckArgs<K,V> args)
Perform spelling correction on a query with additional options.
|
Mono<Long> |
RediSearchReactiveCommands.ftSugadd(K key,
V suggestion,
double score)
Add a suggestion string to an auto-complete suggestion dictionary.
|
Mono<Long> |
RediSearchReactiveCommands.ftSugadd(K key,
V suggestion,
double score,
SugAddArgs<K,V> args)
Add a suggestion string to an auto-complete suggestion dictionary with additional options.
|
Mono<Boolean> |
RediSearchReactiveCommands.ftSugdel(K key,
V suggestion)
Delete a string from a suggestion dictionary.
|
Flux<Suggestion<V>> |
RediSearchReactiveCommands.ftSugget(K key,
V prefix)
Get completion suggestions for a prefix.
|
Flux<Suggestion<V>> |
RediSearchReactiveCommands.ftSugget(K key,
V prefix,
SugGetArgs<K,V> args)
Get completion suggestions for a prefix with additional options.
|
Mono<Long> |
RediSearchReactiveCommands.ftSuglen(K key)
Get the size of an auto-complete suggestion dictionary.
|
Mono<Map<V,List<V>>> |
RediSearchReactiveCommands.ftSyndump(String index)
Dump synonym group contents.
|
Mono<String> |
RediSearchReactiveCommands.ftSynupdate(String index,
V synonymGroupId,
SynUpdateArgs<K,V> args,
V... terms)
Update a synonym group with additional terms and options.
|
Mono<String> |
RediSearchReactiveCommands.ftSynupdate(String index,
V synonymGroupId,
V... terms)
Update a synonym group with additional terms.
|
Flux<V> |
RediSearchReactiveCommands.ftTagvals(String index,
String fieldName)
Return a distinct set of values indexed in a Tag field.
|
Mono<Boolean> |
RedisVectorSetReactiveCommands.vadd(K key,
int dimensionality,
V element,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality. |
Mono<Boolean> |
RedisVectorSetReactiveCommands.vadd(K key,
int dimensionality,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality and additional options. |
Mono<Boolean> |
RedisVectorSetReactiveCommands.vadd(K key,
V element,
Double... vectors)
Add a new element into the vector set specified by
key. |
Mono<Boolean> |
RedisVectorSetReactiveCommands.vadd(K key,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with additional options. |
Mono<Long> |
RedisVectorSetReactiveCommands.vcard(K key)
Returns the number of elements in the vector set stored at
key. |
Mono<Boolean> |
RedisVectorSetReactiveCommands.vClearAttributes(K key,
V element)
Clears all attributes for the specified
element in the vector set stored at key. |
Mono<Long> |
RedisVectorSetReactiveCommands.vdim(K key)
Returns the dimensionality of the vector set stored at
key. |
Flux<Double> |
RedisVectorSetReactiveCommands.vemb(K key,
V element)
Returns the approximate vector associated with a given
element in the vector set stored at key. |
Mono<RawVector> |
RedisVectorSetReactiveCommands.vembRaw(K key,
V element)
Returns the raw vector data for the specified
element in the vector set stored at key. |
Mono<String> |
RedisVectorSetReactiveCommands.vgetattr(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
Flux<JsonValue> |
RedisVectorSetReactiveCommands.vgetattrAsJsonValue(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
Mono<VectorMetadata> |
RedisVectorSetReactiveCommands.vinfo(K key)
Returns metadata and internal details about the vector set stored at
key. |
Flux<V> |
RedisVectorSetReactiveCommands.vlinks(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph of the vector set stored at key. |
Mono<Map<V,Double>> |
RedisVectorSetReactiveCommands.vlinksWithScores(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph along with their scores. |
Mono<V> |
RedisVectorSetReactiveCommands.vrandmember(K key)
Returns a random element from the vector set stored at
key. |
Flux<V> |
RedisVectorSetReactiveCommands.vrandmember(K key,
int count)
Returns multiple random elements from the vector set stored at
key. |
Mono<Boolean> |
RedisVectorSetReactiveCommands.vrem(K key,
V element)
Removes the specified
element from the vector set stored at key. |
Mono<Boolean> |
RedisVectorSetReactiveCommands.vsetattr(K key,
V element,
JsonValue json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
Mono<Boolean> |
RedisVectorSetReactiveCommands.vsetattr(K key,
V element,
String json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
Flux<V> |
RedisVectorSetReactiveCommands.vsim(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key. |
Flux<V> |
RedisVectorSetReactiveCommands.vsim(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key. |
Flux<V> |
RedisVectorSetReactiveCommands.vsim(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options. |
Flux<V> |
RedisVectorSetReactiveCommands.vsim(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options. |
Mono<Map<V,Double>> |
RedisVectorSetReactiveCommands.vsimWithScore(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores. |
Mono<Map<V,Double>> |
RedisVectorSetReactiveCommands.vsimWithScore(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores. |
Mono<Map<V,Double>> |
RedisVectorSetReactiveCommands.vsimWithScore(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores. |
Mono<Map<V,Double>> |
RedisVectorSetReactiveCommands.vsimWithScore(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores. |
Mono<Map<V,VSimScoreAttribs>> |
RedisVectorSetReactiveCommands.vsimWithScoreWithAttribs(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores and attributes. |
Mono<Map<V,VSimScoreAttribs>> |
RedisVectorSetReactiveCommands.vsimWithScoreWithAttribs(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores and attributes. |
Mono<Map<V,VSimScoreAttribs>> |
RedisVectorSetReactiveCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores and attributes. |
Mono<Map<V,VSimScoreAttribs>> |
RedisVectorSetReactiveCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores and attributes. |
| Modifier and Type | Method and Description |
|---|---|
Long |
RedisKeyCommands.delex(K key,
CompareCondition<V> compareCondition)
Delete the specified key if the compare condition matches.
|
String |
RedisKeyCommands.digestKey(K key)
Return the XXH3 64-bit digest of the string value stored at a key as a 16-character hex string.
|
AggregationReply<K,V> |
RediSearchCommands.ftAggregate(String index,
V query)
Run a search query on an index and perform basic aggregate transformations using default options.
|
AggregationReply<K,V> |
RediSearchCommands.ftAggregate(String index,
V query,
AggregateArgs<K,V> args)
Run a search query on an index and perform advanced aggregate transformations with a processing pipeline.
|
String |
RediSearchCommands.ftAliasadd(String alias,
String index)
Add an alias to a search index.
|
String |
RediSearchCommands.ftAliasdel(String alias)
Remove an alias from a search index.
|
String |
RediSearchCommands.ftAliasupdate(String alias,
String index)
Update an existing alias to point to a different search index.
|
String |
RediSearchCommands.ftAlter(String index,
boolean skipInitialScan,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
String |
RediSearchCommands.ftAlter(String index,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
String |
RediSearchCommands.ftCreate(String index,
CreateArgs<K,V> arguments,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name, custom configuration, and field definitions.
|
String |
RediSearchCommands.ftCreate(String index,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name and field definitions using default settings.
|
String |
RediSearchCommands.ftCursordel(String index,
AggregationReply.Cursor cursor)
Delete a cursor and free its associated resources.
|
AggregationReply<K,V> |
RediSearchCommands.ftCursorread(String index,
AggregationReply.Cursor cursor)
Read next results from an existing cursor using the default batch size.
|
AggregationReply<K,V> |
RediSearchCommands.ftCursorread(String index,
AggregationReply.Cursor cursor,
int count)
Read next results from an existing cursor and optionally override the batch size.
|
Long |
RediSearchCommands.ftDictadd(String dict,
V... terms)
Add terms to a dictionary.
|
Long |
RediSearchCommands.ftDictdel(String dict,
V... terms)
Delete terms from a dictionary.
|
List<V> |
RediSearchCommands.ftDictdump(String dict)
Dump all terms in a dictionary.
|
String |
RediSearchCommands.ftDropindex(String index)
Drop a search index without deleting the associated documents.
|
String |
RediSearchCommands.ftDropindex(String index,
boolean deleteDocuments)
Drop a search index with optional document deletion.
|
String |
RediSearchCommands.ftExplain(String index,
V query)
Return the execution plan for a complex query.
|
String |
RediSearchCommands.ftExplain(String index,
V query,
ExplainArgs<K,V> args)
Return the execution plan for a complex query with additional options.
|
HybridReply<K,V> |
RediSearchCommands.ftHybrid(String index,
HybridArgs<K,V> args)
Execute a hybrid query combining text search and vector similarity.
|
List<V> |
RediSearchCommands.ftList()
Return a list of all existing indexes.
|
SearchReply<K,V> |
RediSearchCommands.ftSearch(String index,
V query)
Search the index with a textual query using default search options.
|
SearchReply<K,V> |
RediSearchCommands.ftSearch(String index,
V query,
SearchArgs<K,V> args)
Search the index with a textual query using advanced search options and filters.
|
SpellCheckResult<V> |
RediSearchCommands.ftSpellcheck(String index,
V query)
Perform spelling correction on a query, returning suggestions for misspelled terms.
|
SpellCheckResult<V> |
RediSearchCommands.ftSpellcheck(String index,
V query,
SpellCheckArgs<K,V> args)
Perform spelling correction on a query with additional options.
|
Long |
RediSearchCommands.ftSugadd(K key,
V suggestion,
double score)
Add a suggestion string to an auto-complete suggestion dictionary.
|
Long |
RediSearchCommands.ftSugadd(K key,
V suggestion,
double score,
SugAddArgs<K,V> args)
Add a suggestion string to an auto-complete suggestion dictionary with additional options.
|
Boolean |
RediSearchCommands.ftSugdel(K key,
V suggestion)
Delete a string from a suggestion dictionary.
|
List<Suggestion<V>> |
RediSearchCommands.ftSugget(K key,
V prefix)
Get completion suggestions for a prefix.
|
List<Suggestion<V>> |
RediSearchCommands.ftSugget(K key,
V prefix,
SugGetArgs<K,V> args)
Get completion suggestions for a prefix with additional options.
|
Long |
RediSearchCommands.ftSuglen(K key)
Get the size of an auto-complete suggestion dictionary.
|
Map<V,List<V>> |
RediSearchCommands.ftSyndump(String index)
Dump synonym group contents.
|
String |
RediSearchCommands.ftSynupdate(String index,
V synonymGroupId,
SynUpdateArgs<K,V> args,
V... terms)
Update a synonym group with additional terms and options.
|
String |
RediSearchCommands.ftSynupdate(String index,
V synonymGroupId,
V... terms)
Update a synonym group with additional terms.
|
List<V> |
RediSearchCommands.ftTagvals(String index,
String fieldName)
Return a distinct set of values indexed in a Tag field.
|
Boolean |
RedisVectorSetCommands.vadd(K key,
int dimensionality,
V element,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality. |
Boolean |
RedisVectorSetCommands.vadd(K key,
int dimensionality,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality and additional options. |
Boolean |
RedisVectorSetCommands.vadd(K key,
V element,
Double... vectors)
Add a new element into the vector set specified by
key. |
Boolean |
RedisVectorSetCommands.vadd(K key,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with additional options. |
Long |
RedisVectorSetCommands.vcard(K key)
Returns the number of elements in the vector set stored at
key. |
Boolean |
RedisVectorSetCommands.vClearAttributes(K key,
V element)
Clears all attributes for the specified
element in the vector set stored at key. |
Long |
RedisVectorSetCommands.vdim(K key)
Returns the dimensionality of the vector set stored at
key. |
List<Double> |
RedisVectorSetCommands.vemb(K key,
V element)
Returns the approximate vector associated with a given
element in the vector set stored at key. |
RawVector |
RedisVectorSetCommands.vembRaw(K key,
V element)
Returns the raw vector data for the specified
element in the vector set stored at key. |
String |
RedisVectorSetCommands.vgetattr(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
List<JsonValue> |
RedisVectorSetCommands.vgetattrAsJsonValue(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
VectorMetadata |
RedisVectorSetCommands.vinfo(K key)
Returns metadata and internal details about the vector set stored at
key. |
List<V> |
RedisVectorSetCommands.vlinks(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph of the vector set stored at key. |
Map<V,Double> |
RedisVectorSetCommands.vlinksWithScores(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph along with their scores. |
V |
RedisVectorSetCommands.vrandmember(K key)
Returns a random element from the vector set stored at
key. |
List<V> |
RedisVectorSetCommands.vrandmember(K key,
int count)
Returns multiple random elements from the vector set stored at
key. |
Boolean |
RedisVectorSetCommands.vrem(K key,
V element)
Removes the specified
element from the vector set stored at key. |
Boolean |
RedisVectorSetCommands.vsetattr(K key,
V element,
JsonValue json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
Boolean |
RedisVectorSetCommands.vsetattr(K key,
V element,
String json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
List<V> |
RedisVectorSetCommands.vsim(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key. |
List<V> |
RedisVectorSetCommands.vsim(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key. |
List<V> |
RedisVectorSetCommands.vsim(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options. |
List<V> |
RedisVectorSetCommands.vsim(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options. |
Map<V,Double> |
RedisVectorSetCommands.vsimWithScore(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores. |
Map<V,Double> |
RedisVectorSetCommands.vsimWithScore(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores. |
Map<V,Double> |
RedisVectorSetCommands.vsimWithScore(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores. |
Map<V,Double> |
RedisVectorSetCommands.vsimWithScore(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores. |
Map<V,VSimScoreAttribs> |
RedisVectorSetCommands.vsimWithScoreWithAttribs(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores and attributes. |
Map<V,VSimScoreAttribs> |
RedisVectorSetCommands.vsimWithScoreWithAttribs(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores and attributes. |
Map<V,VSimScoreAttribs> |
RedisVectorSetCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores and attributes. |
Map<V,VSimScoreAttribs> |
RedisVectorSetCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores and attributes. |
| Modifier and Type | Method and Description |
|---|---|
AsyncExecutions<Long> |
NodeSelectionKeyAsyncCommands.delex(K key,
CompareCondition<V> compareCondition)
Delete the specified key if the compare condition matches.
|
AsyncExecutions<String> |
NodeSelectionKeyAsyncCommands.digestKey(K key)
Return the XXH3 64-bit digest of the string value stored at a key as a 16-character hex string.
|
AsyncExecutions<AggregationReply<K,V>> |
NodeSelectionSearchAsyncCommands.ftAggregate(String index,
V query)
Run a search query on an index and perform basic aggregate transformations using default options.
|
AsyncExecutions<AggregationReply<K,V>> |
NodeSelectionSearchAsyncCommands.ftAggregate(String index,
V query,
AggregateArgs<K,V> args)
Run a search query on an index and perform advanced aggregate transformations with a processing pipeline.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftAliasadd(String alias,
String index)
Add an alias to a search index.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftAliasdel(String alias)
Remove an alias from a search index.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftAliasupdate(String alias,
String index)
Update an existing alias to point to a different search index.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftAlter(String index,
boolean skipInitialScan,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftAlter(String index,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftCreate(String index,
CreateArgs<K,V> arguments,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name, custom configuration, and field definitions.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftCreate(String index,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name and field definitions using default settings.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftCursordel(String index,
AggregationReply.Cursor cursor)
Delete a cursor and free its associated resources.
|
AsyncExecutions<AggregationReply<K,V>> |
NodeSelectionSearchAsyncCommands.ftCursorread(String index,
AggregationReply.Cursor cursor)
Read next results from an existing cursor using the default batch size.
|
AsyncExecutions<AggregationReply<K,V>> |
NodeSelectionSearchAsyncCommands.ftCursorread(String index,
AggregationReply.Cursor cursor,
int count)
Read next results from an existing cursor and optionally override the batch size.
|
AsyncExecutions<Long> |
NodeSelectionSearchAsyncCommands.ftDictadd(String dict,
V... terms)
Add terms to a dictionary.
|
AsyncExecutions<Long> |
NodeSelectionSearchAsyncCommands.ftDictdel(String dict,
V... terms)
Delete terms from a dictionary.
|
AsyncExecutions<List<V>> |
NodeSelectionSearchAsyncCommands.ftDictdump(String dict)
Dump all terms in a dictionary.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftDropindex(String index)
Drop a search index without deleting the associated documents.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftDropindex(String index,
boolean deleteDocuments)
Drop a search index with optional document deletion.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftExplain(String index,
V query)
Return the execution plan for a complex query.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftExplain(String index,
V query,
ExplainArgs<K,V> args)
Return the execution plan for a complex query with additional options.
|
AsyncExecutions<HybridReply<K,V>> |
NodeSelectionSearchAsyncCommands.ftHybrid(String index,
HybridArgs<K,V> args)
Execute a hybrid query combining text search and vector similarity.
|
AsyncExecutions<List<V>> |
NodeSelectionSearchAsyncCommands.ftList()
Return a list of all existing indexes.
|
AsyncExecutions<SearchReply<K,V>> |
NodeSelectionSearchAsyncCommands.ftSearch(String index,
V query)
Search the index with a textual query using default search options.
|
AsyncExecutions<SearchReply<K,V>> |
NodeSelectionSearchAsyncCommands.ftSearch(String index,
V query,
SearchArgs<K,V> args)
Search the index with a textual query using advanced search options and filters.
|
AsyncExecutions<SpellCheckResult<V>> |
NodeSelectionSearchAsyncCommands.ftSpellcheck(String index,
V query)
Perform spelling correction on a query, returning suggestions for misspelled terms.
|
AsyncExecutions<SpellCheckResult<V>> |
NodeSelectionSearchAsyncCommands.ftSpellcheck(String index,
V query,
SpellCheckArgs<K,V> args)
Perform spelling correction on a query with additional options.
|
AsyncExecutions<Long> |
NodeSelectionSearchAsyncCommands.ftSugadd(K key,
V suggestion,
double score)
Add a suggestion string to an auto-complete suggestion dictionary.
|
AsyncExecutions<Long> |
NodeSelectionSearchAsyncCommands.ftSugadd(K key,
V suggestion,
double score,
SugAddArgs<K,V> args)
Add a suggestion string to an auto-complete suggestion dictionary with additional options.
|
AsyncExecutions<Boolean> |
NodeSelectionSearchAsyncCommands.ftSugdel(K key,
V suggestion)
Delete a string from a suggestion dictionary.
|
AsyncExecutions<List<Suggestion<V>>> |
NodeSelectionSearchAsyncCommands.ftSugget(K key,
V prefix)
Get completion suggestions for a prefix.
|
AsyncExecutions<List<Suggestion<V>>> |
NodeSelectionSearchAsyncCommands.ftSugget(K key,
V prefix,
SugGetArgs<K,V> args)
Get completion suggestions for a prefix with additional options.
|
AsyncExecutions<Long> |
NodeSelectionSearchAsyncCommands.ftSuglen(K key)
Get the size of an auto-complete suggestion dictionary.
|
AsyncExecutions<Map<V,List<V>>> |
NodeSelectionSearchAsyncCommands.ftSyndump(String index)
Dump synonym group contents.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftSynupdate(String index,
V synonymGroupId,
SynUpdateArgs<K,V> args,
V... terms)
Update a synonym group with additional terms and options.
|
AsyncExecutions<String> |
NodeSelectionSearchAsyncCommands.ftSynupdate(String index,
V synonymGroupId,
V... terms)
Update a synonym group with additional terms.
|
AsyncExecutions<List<V>> |
NodeSelectionSearchAsyncCommands.ftTagvals(String index,
String fieldName)
Return a distinct set of values indexed in a Tag field.
|
AsyncExecutions<Boolean> |
NodeSelectionVectorSetAsyncCommands.vadd(K key,
int dimensionality,
V element,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality. |
AsyncExecutions<Boolean> |
NodeSelectionVectorSetAsyncCommands.vadd(K key,
int dimensionality,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality and additional options. |
AsyncExecutions<Boolean> |
NodeSelectionVectorSetAsyncCommands.vadd(K key,
V element,
Double... vectors)
Add a new element into the vector set specified by
key. |
AsyncExecutions<Boolean> |
NodeSelectionVectorSetAsyncCommands.vadd(K key,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with additional options. |
AsyncExecutions<Long> |
NodeSelectionVectorSetAsyncCommands.vcard(K key)
Returns the number of elements in the vector set stored at
key. |
AsyncExecutions<Boolean> |
NodeSelectionVectorSetAsyncCommands.vClearAttributes(K key,
V element)
Clears all attributes for the specified
element in the vector set stored at key. |
AsyncExecutions<Long> |
NodeSelectionVectorSetAsyncCommands.vdim(K key)
Returns the dimensionality of the vector set stored at
key. |
AsyncExecutions<List<Double>> |
NodeSelectionVectorSetAsyncCommands.vemb(K key,
V element)
Returns the approximate vector associated with a given
element in the vector set stored at key. |
AsyncExecutions<RawVector> |
NodeSelectionVectorSetAsyncCommands.vembRaw(K key,
V element)
Returns the raw vector data for the specified
element in the vector set stored at key. |
AsyncExecutions<String> |
NodeSelectionVectorSetAsyncCommands.vgetattr(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
AsyncExecutions<List<JsonValue>> |
NodeSelectionVectorSetAsyncCommands.vgetattrAsJsonValue(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
AsyncExecutions<VectorMetadata> |
NodeSelectionVectorSetAsyncCommands.vinfo(K key)
Returns metadata and internal details about the vector set stored at
key. |
AsyncExecutions<List<V>> |
NodeSelectionVectorSetAsyncCommands.vlinks(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph of the vector set stored at key. |
AsyncExecutions<Map<V,Double>> |
NodeSelectionVectorSetAsyncCommands.vlinksWithScores(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph along with their scores. |
AsyncExecutions<V> |
NodeSelectionVectorSetAsyncCommands.vrandmember(K key)
Returns a random element from the vector set stored at
key. |
AsyncExecutions<List<V>> |
NodeSelectionVectorSetAsyncCommands.vrandmember(K key,
int count)
Returns multiple random elements from the vector set stored at
key. |
AsyncExecutions<Boolean> |
NodeSelectionVectorSetAsyncCommands.vrem(K key,
V element)
Removes the specified
element from the vector set stored at key. |
AsyncExecutions<Boolean> |
NodeSelectionVectorSetAsyncCommands.vsetattr(K key,
V element,
JsonValue json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
AsyncExecutions<Boolean> |
NodeSelectionVectorSetAsyncCommands.vsetattr(K key,
V element,
String json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
AsyncExecutions<List<V>> |
NodeSelectionVectorSetAsyncCommands.vsim(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key. |
AsyncExecutions<List<V>> |
NodeSelectionVectorSetAsyncCommands.vsim(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key. |
AsyncExecutions<List<V>> |
NodeSelectionVectorSetAsyncCommands.vsim(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options. |
AsyncExecutions<List<V>> |
NodeSelectionVectorSetAsyncCommands.vsim(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options. |
AsyncExecutions<Map<V,Double>> |
NodeSelectionVectorSetAsyncCommands.vsimWithScore(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores. |
AsyncExecutions<Map<V,Double>> |
NodeSelectionVectorSetAsyncCommands.vsimWithScore(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores. |
AsyncExecutions<Map<V,Double>> |
NodeSelectionVectorSetAsyncCommands.vsimWithScore(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores. |
AsyncExecutions<Map<V,Double>> |
NodeSelectionVectorSetAsyncCommands.vsimWithScore(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores. |
AsyncExecutions<Map<V,VSimScoreAttribs>> |
NodeSelectionVectorSetAsyncCommands.vsimWithScoreWithAttribs(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores and attributes. |
AsyncExecutions<Map<V,VSimScoreAttribs>> |
NodeSelectionVectorSetAsyncCommands.vsimWithScoreWithAttribs(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores and attributes. |
AsyncExecutions<Map<V,VSimScoreAttribs>> |
NodeSelectionVectorSetAsyncCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores and attributes. |
AsyncExecutions<Map<V,VSimScoreAttribs>> |
NodeSelectionVectorSetAsyncCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores and attributes. |
| Modifier and Type | Method and Description |
|---|---|
Executions<Long> |
NodeSelectionKeyCommands.delex(K key,
CompareCondition<V> compareCondition)
Delete the specified key if the compare condition matches.
|
Executions<String> |
NodeSelectionKeyCommands.digestKey(K key)
Return the XXH3 64-bit digest of the string value stored at a key as a 16-character hex string.
|
Executions<AggregationReply<K,V>> |
NodeSelectionSearchCommands.ftAggregate(String index,
V query)
Run a search query on an index and perform basic aggregate transformations using default options.
|
Executions<AggregationReply<K,V>> |
NodeSelectionSearchCommands.ftAggregate(String index,
V query,
AggregateArgs<K,V> args)
Run a search query on an index and perform advanced aggregate transformations with a processing pipeline.
|
Executions<String> |
NodeSelectionSearchCommands.ftAliasadd(String alias,
String index)
Add an alias to a search index.
|
Executions<String> |
NodeSelectionSearchCommands.ftAliasdel(String alias)
Remove an alias from a search index.
|
Executions<String> |
NodeSelectionSearchCommands.ftAliasupdate(String alias,
String index)
Update an existing alias to point to a different search index.
|
Executions<String> |
NodeSelectionSearchCommands.ftAlter(String index,
boolean skipInitialScan,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
Executions<String> |
NodeSelectionSearchCommands.ftAlter(String index,
List<FieldArgs<K>> fieldArgs)
Add new attributes to an existing search index.
|
Executions<String> |
NodeSelectionSearchCommands.ftCreate(String index,
CreateArgs<K,V> arguments,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name, custom configuration, and field definitions.
|
Executions<String> |
NodeSelectionSearchCommands.ftCreate(String index,
List<FieldArgs<K>> fieldArgs)
Create a new search index with the given name and field definitions using default settings.
|
Executions<String> |
NodeSelectionSearchCommands.ftCursordel(String index,
AggregationReply.Cursor cursor)
Delete a cursor and free its associated resources.
|
Executions<AggregationReply<K,V>> |
NodeSelectionSearchCommands.ftCursorread(String index,
AggregationReply.Cursor cursor)
Read next results from an existing cursor using the default batch size.
|
Executions<AggregationReply<K,V>> |
NodeSelectionSearchCommands.ftCursorread(String index,
AggregationReply.Cursor cursor,
int count)
Read next results from an existing cursor and optionally override the batch size.
|
Executions<Long> |
NodeSelectionSearchCommands.ftDictadd(String dict,
V... terms)
Add terms to a dictionary.
|
Executions<Long> |
NodeSelectionSearchCommands.ftDictdel(String dict,
V... terms)
Delete terms from a dictionary.
|
Executions<List<V>> |
NodeSelectionSearchCommands.ftDictdump(String dict)
Dump all terms in a dictionary.
|
Executions<String> |
NodeSelectionSearchCommands.ftDropindex(String index)
Drop a search index without deleting the associated documents.
|
Executions<String> |
NodeSelectionSearchCommands.ftDropindex(String index,
boolean deleteDocuments)
Drop a search index with optional document deletion.
|
Executions<String> |
NodeSelectionSearchCommands.ftExplain(String index,
V query)
Return the execution plan for a complex query.
|
Executions<String> |
NodeSelectionSearchCommands.ftExplain(String index,
V query,
ExplainArgs<K,V> args)
Return the execution plan for a complex query with additional options.
|
Executions<HybridReply<K,V>> |
NodeSelectionSearchCommands.ftHybrid(String index,
HybridArgs<K,V> args)
Execute a hybrid query combining text search and vector similarity.
|
Executions<List<V>> |
NodeSelectionSearchCommands.ftList()
Return a list of all existing indexes.
|
Executions<SearchReply<K,V>> |
NodeSelectionSearchCommands.ftSearch(String index,
V query)
Search the index with a textual query using default search options.
|
Executions<SearchReply<K,V>> |
NodeSelectionSearchCommands.ftSearch(String index,
V query,
SearchArgs<K,V> args)
Search the index with a textual query using advanced search options and filters.
|
Executions<SpellCheckResult<V>> |
NodeSelectionSearchCommands.ftSpellcheck(String index,
V query)
Perform spelling correction on a query, returning suggestions for misspelled terms.
|
Executions<SpellCheckResult<V>> |
NodeSelectionSearchCommands.ftSpellcheck(String index,
V query,
SpellCheckArgs<K,V> args)
Perform spelling correction on a query with additional options.
|
Executions<Long> |
NodeSelectionSearchCommands.ftSugadd(K key,
V suggestion,
double score)
Add a suggestion string to an auto-complete suggestion dictionary.
|
Executions<Long> |
NodeSelectionSearchCommands.ftSugadd(K key,
V suggestion,
double score,
SugAddArgs<K,V> args)
Add a suggestion string to an auto-complete suggestion dictionary with additional options.
|
Executions<Boolean> |
NodeSelectionSearchCommands.ftSugdel(K key,
V suggestion)
Delete a string from a suggestion dictionary.
|
Executions<List<Suggestion<V>>> |
NodeSelectionSearchCommands.ftSugget(K key,
V prefix)
Get completion suggestions for a prefix.
|
Executions<List<Suggestion<V>>> |
NodeSelectionSearchCommands.ftSugget(K key,
V prefix,
SugGetArgs<K,V> args)
Get completion suggestions for a prefix with additional options.
|
Executions<Long> |
NodeSelectionSearchCommands.ftSuglen(K key)
Get the size of an auto-complete suggestion dictionary.
|
Executions<Map<V,List<V>>> |
NodeSelectionSearchCommands.ftSyndump(String index)
Dump synonym group contents.
|
Executions<String> |
NodeSelectionSearchCommands.ftSynupdate(String index,
V synonymGroupId,
SynUpdateArgs<K,V> args,
V... terms)
Update a synonym group with additional terms and options.
|
Executions<String> |
NodeSelectionSearchCommands.ftSynupdate(String index,
V synonymGroupId,
V... terms)
Update a synonym group with additional terms.
|
Executions<List<V>> |
NodeSelectionSearchCommands.ftTagvals(String index,
String fieldName)
Return a distinct set of values indexed in a Tag field.
|
Executions<Boolean> |
NodeSelectionVectorSetCommands.vadd(K key,
int dimensionality,
V element,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality. |
Executions<Boolean> |
NodeSelectionVectorSetCommands.vadd(K key,
int dimensionality,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with the specified dimensionality and additional options. |
Executions<Boolean> |
NodeSelectionVectorSetCommands.vadd(K key,
V element,
Double... vectors)
Add a new element into the vector set specified by
key. |
Executions<Boolean> |
NodeSelectionVectorSetCommands.vadd(K key,
V element,
VAddArgs args,
Double... vectors)
Add a new element into the vector set specified by
key with additional options. |
Executions<Long> |
NodeSelectionVectorSetCommands.vcard(K key)
Returns the number of elements in the vector set stored at
key. |
Executions<Boolean> |
NodeSelectionVectorSetCommands.vClearAttributes(K key,
V element)
Clears all attributes for the specified
element in the vector set stored at key. |
Executions<Long> |
NodeSelectionVectorSetCommands.vdim(K key)
Returns the dimensionality of the vector set stored at
key. |
Executions<List<Double>> |
NodeSelectionVectorSetCommands.vemb(K key,
V element)
Returns the approximate vector associated with a given
element in the vector set stored at key. |
Executions<RawVector> |
NodeSelectionVectorSetCommands.vembRaw(K key,
V element)
Returns the raw vector data for the specified
element in the vector set stored at key. |
Executions<String> |
NodeSelectionVectorSetCommands.vgetattr(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
Executions<List<JsonValue>> |
NodeSelectionVectorSetCommands.vgetattrAsJsonValue(K key,
V element)
Returns the attributes associated with the specified
element in the vector set stored at key. |
Executions<VectorMetadata> |
NodeSelectionVectorSetCommands.vinfo(K key)
Returns metadata and internal details about the vector set stored at
key. |
Executions<List<V>> |
NodeSelectionVectorSetCommands.vlinks(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph of the vector set stored at key. |
Executions<Map<V,Double>> |
NodeSelectionVectorSetCommands.vlinksWithScores(K key,
V element)
Returns the neighbors of the specified
element in the HNSW graph along with their scores. |
Executions<V> |
NodeSelectionVectorSetCommands.vrandmember(K key)
Returns a random element from the vector set stored at
key. |
Executions<List<V>> |
NodeSelectionVectorSetCommands.vrandmember(K key,
int count)
Returns multiple random elements from the vector set stored at
key. |
Executions<Boolean> |
NodeSelectionVectorSetCommands.vrem(K key,
V element)
Removes the specified
element from the vector set stored at key. |
Executions<Boolean> |
NodeSelectionVectorSetCommands.vsetattr(K key,
V element,
JsonValue json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
Executions<Boolean> |
NodeSelectionVectorSetCommands.vsetattr(K key,
V element,
String json)
Sets or updates the attributes for the specified
element in the vector set stored at key. |
Executions<List<V>> |
NodeSelectionVectorSetCommands.vsim(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key. |
Executions<List<V>> |
NodeSelectionVectorSetCommands.vsim(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key. |
Executions<List<V>> |
NodeSelectionVectorSetCommands.vsim(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options. |
Executions<List<V>> |
NodeSelectionVectorSetCommands.vsim(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options. |
Executions<Map<V,Double>> |
NodeSelectionVectorSetCommands.vsimWithScore(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores. |
Executions<Map<V,Double>> |
NodeSelectionVectorSetCommands.vsimWithScore(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores. |
Executions<Map<V,Double>> |
NodeSelectionVectorSetCommands.vsimWithScore(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores. |
Executions<Map<V,Double>> |
NodeSelectionVectorSetCommands.vsimWithScore(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores. |
Executions<Map<V,VSimScoreAttribs>> |
NodeSelectionVectorSetCommands.vsimWithScoreWithAttribs(K key,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key and returns them with
their similarity scores and attributes. |
Executions<Map<V,VSimScoreAttribs>> |
NodeSelectionVectorSetCommands.vsimWithScoreWithAttribs(K key,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key and returns them
with their similarity scores and attributes. |
Executions<Map<V,VSimScoreAttribs>> |
NodeSelectionVectorSetCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
Double... vectors)
Finds the most similar vectors to the given query vector in the vector set stored at
key with additional options
and returns them with their similarity scores and attributes. |
Executions<Map<V,VSimScoreAttribs>> |
NodeSelectionVectorSetCommands.vsimWithScoreWithAttribs(K key,
VSimArgs args,
V element)
Finds the most similar vectors to the given element's vector in the vector set stored at
key with additional
options and returns them with their similarity scores and attributes. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
CircuitBreaker
Circuit breaker for tracking command metrics and managing circuit breaker state.
|
interface |
CircuitBreakerGeneration
Represents a specific generation of a circuit breaker.
|
class |
CircuitBreakerStateChangeEvent
Event representing a circuit breaker state change.
|
class |
DatabaseConfig
Configuration for a database in a multi-database client.
|
interface |
DatabaseRawConnectionFactory
Factory interface to obtain direct
connections to Redis database nodes. |
interface |
MultiDbClient |
class |
RedisCircuitBreakerException
Exception thrown when a circuit breaker is not in closed state.
|
class |
RedisDatabase<C extends StatefulRedisConnection<?,?>>
Represents a Redis database with a weight and a connection.
|
class |
StatefulRedisMultiDbConnectionImpl<C extends StatefulRedisConnection<K,V>,K,V>
Stateful connection wrapper that holds multiple underlying connections and delegates to the currently active one.
|
class |
StatefulRedisMultiDbPubSubConnectionImpl<K,V> |
| Modifier and Type | Interface and Description |
|---|---|
interface |
BaseRedisMultiDbConnection |
interface |
CircuitBreakerStateListener
Listener interface for circuit breaker state change events.
|
interface |
StatefulRedisMultiDbConnection<K,V>
Stateful multi-database Redis connection that supports failover between multiple endpoints.
|
interface |
StatefulRedisMultiDbPubSubConnection<K,V>
Stateful multi-database Redis PubSub connection that supports failover between multiple endpoints.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
HealthCheck
Interface for health check operations on a Redis endpoint.
|
class |
HealthCheckCollection
Collection of health checks.
|
class |
HealthCheckImpl
Implementation of the
HealthCheck interface. |
interface |
HealthCheckStrategy
Interface for health check strategies.
|
interface |
HealthCheckStrategySupplier
Supplier for health check strategies.
|
class |
HealthStatus
Enumeration representing the health status of a database endpoint as determined by the health check service.
|
class |
HealthStatusChangeEvent
Event arguments for health status change events.
|
interface |
HealthStatusListener
Listener for health status changes.
|
interface |
HealthStatusManager
Manager for health status of Redis endpoints.
|
class |
HealthStatusManagerImpl
Implementation of the
HealthStatusManager interface. |
class |
PingStrategy
Health check strategy that uses PING command to check endpoint health.
|
interface |
ProbingPolicy
Interface for probing policies.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CircuitBreakerMetrics
Interface for sliding window metrics.
|
class |
MetricsFactory
Factory for creating
CircuitBreakerMetrics instances. |
interface |
MetricsSnapshot
Represents the state of success and failure counts within a specific time window.
|
| Modifier and Type | Class and Description |
|---|---|
class |
HybridReply<K,V>
Represents the results of an
FT.HYBRID command. |
class |
HybridReplyParser<K,V>
Parser for
FT.HYBRID responses. |
| Modifier and Type | Class and Description |
|---|---|
class |
CombineArgs<K>
Arguments for the COMBINE clause in FT.HYBRID command.
|
class |
HybridSearchArgs<K,V>
Arguments for the SEARCH clause in FT.HYBRID command.
|
class |
HybridVectorArgs<K,V>
Arguments for the VSIM clause in FT.HYBRID command.
|
class |
PostProcessingArgs<K,V>
Argument list builder for FT.HYBRID and FT.AGGREGATE post-processing operations.
|
Copyright © 2025 lettuce.io. All rights reserved.