io.lettuce.core.search.arguments

Class CreateArgs.Builder

java.lang.Object

io.lettuce.core.search.arguments.CreateArgs.Builder

Enclosing class:

CreateArgs

public static class CreateArgs.Builder
extends Object

Builder for CreateArgs.

As a final step the build() method needs to be executed to create the final CreateArgs instance.

See Also:

FT.CREATE

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CreateArgs	build()
CreateArgs.Builder	defaultLanguage(DocumentLanguage language) Set the default language for the documents in the index.
CreateArgs.Builder	defaultScore(double score) Set the default score for the documents in the index.
CreateArgs.Builder	filter(String filter) Set a filter for the index.
CreateArgs.Builder	languageField(String field) Set the field that contains the language setting for the documents in the index.
CreateArgs.Builder	maxTextFields() Set the maximum number of text fields in the index.
CreateArgs.Builder	noFields() Set the no fields flag.
CreateArgs.Builder	noFrequency() Set the no frequency flag.
CreateArgs.Builder	noHighlighting() Set the no highlighting flag.
CreateArgs.Builder	noOffsets() Set the no offsets flag.
CreateArgs.Builder	on(CreateArgs.TargetType targetType) Set the CreateArgs.TargetType type for the index.
CreateArgs.Builder	payloadField(String field) Set the field that contains the payload setting for the documents in the index.
CreateArgs.Builder	scoreField(String field) Set the field that contains the score setting for the documents in the index.
CreateArgs.Builder	skipInitialScan() Set the skip initial scan flag.
CreateArgs.Builder	stopWords(List<String> stopWords) Set the index with a custom stopword list, to be ignored during indexing and search time.
CreateArgs.Builder	temporary(long seconds) Set the temporary index expiration time in seconds.
CreateArgs.Builder	withPrefix(String prefix) Add a prefix to the index.
CreateArgs.Builder	withPrefixes(List<String> prefixes) Add a list of prefixes to the index.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

on

public CreateArgs.Builder on(CreateArgs.TargetType targetType)

Set the CreateArgs.TargetType type for the index. Defaults to CreateArgs.TargetType.HASH.

Parameters:

targetType - the target type

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

withPrefix

public CreateArgs.Builder withPrefix(String prefix)

Add a prefix to the index. You can add several prefixes to index. Default setting is * (all keys).

The prefix is sent as written and is not passed through the key codec. With a codec that transforms keys, pass the physical prefix of the stored keys, for example tenant:user: for a codec that prepends tenant:.

Parameters:

prefix - the prefix

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

withPrefixes

public CreateArgs.Builder withPrefixes(List<String> prefixes)

Add a list of prefixes to the index. You can add several prefixes to index. Default setting is * (all keys).

The prefixes are sent as written and is not passed through the key codec. With a codec that transforms keys, pass the physical prefix of the stored keys, for example tenant:user: for a codec that prepends tenant:.

Parameters:

prefixes - a List of prefixes

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

filter

public CreateArgs.Builder filter(String filter)

Set a filter for the index. Default setting is to have no filter.

It is possible to use @__key to access the key that was just added/changed. A field can be used to set field name by passing 'FILTER @indexName=="myindexname"'.

Parameters:

filter - a filter expression with the full RediSearch aggregation expression language

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

See Also:

RediSearch Query

defaultLanguage

public CreateArgs.Builder defaultLanguage(DocumentLanguage language)

Set the default language for the documents in the index. The default setting is English.

Parameters:

language - the default language

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

languageField

public CreateArgs.Builder languageField(String field)

Set the field that contains the language setting for the documents in the index. The default setting is to have no language field.

Parameters:

field - the language field

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

See Also:

Stemming

defaultScore

public CreateArgs.Builder defaultScore(double score)

Set the default score for the documents in the index. The default setting is 1.0.

Parameters:

score - the default score

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

See Also:

Scoring

scoreField

public CreateArgs.Builder scoreField(String field)

Set the field that contains the score setting for the documents in the index. The default setting is a score of 1.0.

Parameters:

field - the score field

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

See Also:

Scoring

payloadField

public CreateArgs.Builder payloadField(String field)

Set the field that contains the payload setting for the documents in the index. The default setting is to have no payload field.

This should be a document attribute that you use as a binary safe payload string to the document that can be evaluated at query time by a custom scoring function or retrieved to the client

Parameters:

field - the payload field

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

See Also:

Scoring

maxTextFields

public CreateArgs.Builder maxTextFields()

Set the maximum number of text fields in the index. The default setting is to have no limit.

Forces RediSearch to encode indexes as if there were more than 32 text attributes, which allows you to add additional attributes (beyond 32) using FT.ALTER. For efficiency, RediSearch encodes indexes differently if they are created with less than 32 text attributes.

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

temporary

public CreateArgs.Builder temporary(long seconds)

Set the temporary index expiration time in seconds. The default setting is to have no expiration time.

Creates a lightweight temporary index that expires after a specified period of inactivity, in seconds. The internal idle timer is reset whenever the index is searched or added to. Because such indexes are lightweight, you can create thousands of such indexes without negative performance implications and, therefore, you should consider using skipInitialScan() to avoid costly scanning.

Warning: When temporary indexes expire, they drop all the records associated with them. FT.DROPINDEX was introduced with a default of not deleting docs and a DD flag that enforced deletion. However, for temporary indexes, documents are deleted along with the index. Historically, RediSearch used an FT.ADD command, which made a connection between the document and the index. Then, FT.DROP, also a hystoric command, deleted documents by default. In version 2.x, RediSearch indexes hashes and JSONs, and the dependency between the index and documents no longer exists.

Parameters:

seconds - the temporary index expiration time in seconds

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

noOffsets

public CreateArgs.Builder noOffsets()

Set the no offsets flag. The default setting is to have offsets.

It saves memory, but does not allow exact searches or highlighting. It implies noHighlighting() is set to true.

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

noHighlighting

public CreateArgs.Builder noHighlighting()

Set the no highlighting flag. The default setting is to have highlighting.

Conserves storage space and memory by disabling highlighting support. If set, the corresponding byte offsets for term positions are not stored. NOHL is also implied by NOOFFSETS.

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

noFields

public CreateArgs.Builder noFields()

Set the no fields flag. The default setting is to have fields.

Does not store attribute bits for each term. It saves memory, but it does not allow filtering by specific attributes.

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

noFrequency

public CreateArgs.Builder noFrequency()

Set the no frequency flag. The default setting is to have frequencies.

Does not store the frequency of each term. It saves memory, but it does not allow sorting by frequency of a given term.

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

skipInitialScan

public CreateArgs.Builder skipInitialScan()

Set the skip initial scan flag. The default setting is to scan initially.

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

stopWords

public CreateArgs.Builder stopWords(List<String> stopWords)

Set the index with a custom stopword list, to be ignored during indexing and search time.

If not set, FT.CREATE takes the default list of stopwords. If {count} is set to 0, the index does not have stopwords.

Parameters:

stopWords - a list of stop words

Returns:

the instance of the current CreateArgs.Builder for the purpose of method chaining

See Also:

Stop words

build

public CreateArgs build()