Package glide.api.models.commands.FT

Class FTSearchOptions.FTSearchOptionsBuilder

java.lang.Object

glide.api.models.commands.FT.FTSearchOptions.FTSearchOptionsBuilder

Enclosing class:

FTSearchOptions

public static class FTSearchOptions.FTSearchOptionsBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
FTSearchOptionsBuilder()

Method Summary

Modifier and Type	Method	Description
FTSearchOptions.FTSearchOptionsBuilder	addReturnField(@NonNull GlideString field)	Add a field to be returned.
FTSearchOptions.FTSearchOptionsBuilder	addReturnField(@NonNull GlideString field, @NonNull GlideString alias)	Add a field with an alias to be returned.
FTSearchOptions.FTSearchOptionsBuilder	addReturnField(@NonNull java.lang.String field)	Add a field to be returned.
FTSearchOptions.FTSearchOptionsBuilder	addReturnField(@NonNull java.lang.String field, @NonNull java.lang.String alias)	Add a field with an alias to be returned.
FTSearchOptions	build()
FTSearchOptions.FTSearchOptionsBuilder	consistency(@NonNull FTSearchOptions.ConsistencyMode consistency)	Set the consistency mode for cluster mode queries.
FTSearchOptions.FTSearchOptionsBuilder	count()	Once set, the query will return only number of documents in the result set without actually returning them.
FTSearchOptions.FTSearchOptionsBuilder	dialect(int dialect)	Set the query dialect version.
FTSearchOptions.FTSearchOptionsBuilder	inorder()	If set, proximity matching of text terms must be in order.
FTSearchOptions.FTSearchOptionsBuilder	limit(int offset, int count)	Configure query pagination.
FTSearchOptions.FTSearchOptionsBuilder	nocontent()	Once set, the query will return only document IDs without any field content.
FTSearchOptions.FTSearchOptionsBuilder	params(java.util.Map<GlideString,GlideString> params)	Query parameters, which could be referenced in the query by $ sign, followed by the parameter name.
FTSearchOptions.FTSearchOptionsBuilder	shardScope(@NonNull FTSearchOptions.ShardScope shardScope)	Set the shard scope for cluster mode queries.
FTSearchOptions.FTSearchOptionsBuilder	slop(int slop)	Set the slop value for proximity matching of text terms.
FTSearchOptions.FTSearchOptionsBuilder	sortBy(@NonNull GlideString field)	Sort results by a field.
FTSearchOptions.FTSearchOptionsBuilder	sortBy(@NonNull GlideString field, @NonNull FTSearchOptions.SortOrder order)	Sort results by a field with a specified order.
FTSearchOptions.FTSearchOptionsBuilder	sortBy(@NonNull java.lang.String field)	Sort results by a field.
FTSearchOptions.FTSearchOptionsBuilder	sortBy(@NonNull java.lang.String field, @NonNull FTSearchOptions.SortOrder order)	Sort results by a field with a specified order.
FTSearchOptions.FTSearchOptionsBuilder	sortByOrder(FTSearchOptions.SortOrder sortByOrder)
FTSearchOptions.FTSearchOptionsBuilder	timeout(java.lang.Integer timeout)	Query timeout in milliseconds.
java.lang.String	toString()
FTSearchOptions.FTSearchOptionsBuilder	verbatim()	If set, stemming is not applied to text terms in the query.
FTSearchOptions.FTSearchOptionsBuilder	withSortKeys()	If set and sortBy is specified, augments the output with the sort key value.

Methods inherited from class java.lang.Object

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

Constructor Detail

FTSearchOptionsBuilder

public FTSearchOptionsBuilder()

Method Detail

addReturnField

public FTSearchOptions.FTSearchOptionsBuilder addReturnField(@NonNull
                                                             @NonNull java.lang.String field)

Add a field to be returned.

addReturnField

public FTSearchOptions.FTSearchOptionsBuilder addReturnField(@NonNull
                                                             @NonNull java.lang.String field,
                                                             @NonNull
                                                             @NonNull java.lang.String alias)

Add a field with an alias to be returned.

addReturnField

public FTSearchOptions.FTSearchOptionsBuilder addReturnField(@NonNull
                                                             @NonNull GlideString field)

Add a field to be returned.

addReturnField

public FTSearchOptions.FTSearchOptionsBuilder addReturnField(@NonNull
                                                             @NonNull GlideString field,
                                                             @NonNull
                                                             @NonNull GlideString alias)

Add a field with an alias to be returned.

limit

public FTSearchOptions.FTSearchOptionsBuilder limit(int offset,
                                                    int count)

Configure query pagination. By default only first 10 documents are returned.

Parameters:

offset - Zero-based offset.

count - Number of elements to return.

count

public FTSearchOptions.FTSearchOptionsBuilder count()

Once set, the query will return only number of documents in the result set without actually returning them.

nocontent

public FTSearchOptions.FTSearchOptionsBuilder nocontent()

Once set, the query will return only document IDs without any field content.

dialect

public FTSearchOptions.FTSearchOptionsBuilder dialect(int dialect)

Set the query dialect version.

Parameters:

dialect - The dialect version (currently, only dialect 2 is supported in valkey-search).

verbatim

public FTSearchOptions.FTSearchOptionsBuilder verbatim()

If set, stemming is not applied to text terms in the query.

inorder

public FTSearchOptions.FTSearchOptionsBuilder inorder()

If set, proximity matching of text terms must be in order.

slop

public FTSearchOptions.FTSearchOptionsBuilder slop(int slop)

Set the slop value for proximity matching of text terms.

Parameters:

slop - The maximum number of intervening terms allowed between query terms.

sortBy

public FTSearchOptions.FTSearchOptionsBuilder sortBy(@NonNull
                                                     @NonNull java.lang.String field)

Sort results by a field.

Parameters:

field - The field name to sort by.

sortBy

public FTSearchOptions.FTSearchOptionsBuilder sortBy(@NonNull
                                                     @NonNull GlideString field)

Sort results by a field.

Parameters:

field - The field name to sort by.

sortBy

public FTSearchOptions.FTSearchOptionsBuilder sortBy(@NonNull
                                                     @NonNull java.lang.String field,
                                                     @NonNull
                                                     @NonNull FTSearchOptions.SortOrder order)

Sort results by a field with a specified order.

Parameters:

field - The field name to sort by.

order - The sort order (ASC or DESC).

sortBy

public FTSearchOptions.FTSearchOptionsBuilder sortBy(@NonNull
                                                     @NonNull GlideString field,
                                                     @NonNull
                                                     @NonNull FTSearchOptions.SortOrder order)

Sort results by a field with a specified order.

Parameters:

field - The field name to sort by.

order - The sort order (ASC or DESC).

withSortKeys

public FTSearchOptions.FTSearchOptionsBuilder withSortKeys()

If set and sortBy is specified, augments the output with the sort key value.

When WITHSORTKEYS is enabled, the response format changes: each document entry becomes a two-element array [sortKey, fieldMap] instead of just fieldMap. The sort key is the value of the field used for sorting (or null if the field is missing from the document).

shardScope

public FTSearchOptions.FTSearchOptionsBuilder shardScope(@NonNull
                                                         @NonNull FTSearchOptions.ShardScope shardScope)

Set the shard scope for cluster mode queries.

Parameters:

shardScope - The shard scope (ALLSHARDS or SOMESHARDS).

consistency

public FTSearchOptions.FTSearchOptionsBuilder consistency(@NonNull
                                                          @NonNull FTSearchOptions.ConsistencyMode consistency)

Set the consistency mode for cluster mode queries.

Parameters:

consistency - The consistency mode (CONSISTENT or INCONSISTENT).

timeout

public FTSearchOptions.FTSearchOptionsBuilder timeout(java.lang.Integer timeout)

Query timeout in milliseconds.

Returns:

this.

params

public FTSearchOptions.FTSearchOptionsBuilder params(java.util.Map<GlideString,GlideString> params)

Query parameters, which could be referenced in the query by $ sign, followed by the parameter name.

Returns:

this.

sortByOrder

public FTSearchOptions.FTSearchOptionsBuilder sortByOrder(FTSearchOptions.SortOrder sortByOrder)

Returns:

this.

build

public FTSearchOptions build()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object