io.lettuce.core.search.arguments

Class TextFieldArgs

java.lang.Object

io.lettuce.core.search.arguments.FieldArgs

io.lettuce.core.search.arguments.TextFieldArgs

public class TextFieldArgs
extends FieldArgs

Field arguments for TEXT fields in a RediSearch index.

Text fields are specifically designed for storing human language text. When indexing text fields, Redis performs several transformations to optimize search capabilities. The text is transformed to lowercase, allowing case-insensitive searches. The data is tokenized, meaning it is split into individual words or tokens, which enables efficient full-text search functionality.

Since:

6.8

Author:

Tihomir Mateev

See Also:

Text Fields

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextFieldArgs.Builder Builder for TextFieldArgs.
static class	TextFieldArgs.PhoneticMatcher Phonetic matchers for text fields.

Field Summary

Fields inherited from class io.lettuce.core.search.arguments.FieldArgs

as, indexEmpty, indexMissing, name, noIndex, sortable, unNormalizedForm

Constructor Summary

Constructors

Constructor and Description
TextFieldArgs()

Method Summary

Modifier and Type	Method and Description
static TextFieldArgs.Builder	builder() Create a new TextFieldArgs using the builder pattern.
protected void	buildTypeSpecificArgs(CommandArgs<?,?> args) Add type-specific arguments to the command.
String	getFieldType() Returns the field type.
Optional<TextFieldArgs.PhoneticMatcher>	getPhonetic() Get the phonetic matcher.
Optional<Long>	getWeight() Get the weight of the field.
boolean	isNoStem() Check if stemming is disabled.
boolean	isWithSuffixTrie() Check if suffix trie is enabled.

Methods inherited from class io.lettuce.core.search.arguments.FieldArgs

build, getAs, getName, isIndexEmpty, isIndexMissing, isNoIndex, isSortable, isUnNormalizedForm

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFieldArgs

public TextFieldArgs()

Method Detail

builder

public static TextFieldArgs.Builder builder()

Create a new TextFieldArgs using the builder pattern.

Returns:

a new TextFieldArgs.Builder

getFieldType

public String getFieldType()

Description copied from class: FieldArgs

Returns the field type. Subclasses must implement this method.

Specified by:

getFieldType in class FieldArgs

Returns:

the field type

getWeight

public Optional<Long> getWeight()

Get the weight of the field.

Returns:

the weight

isNoStem

public boolean isNoStem()

Check if stemming is disabled.

Returns:

true if stemming is disabled

getPhonetic

public Optional<TextFieldArgs.PhoneticMatcher> getPhonetic()

Get the phonetic matcher.

Returns:

the phonetic matcher

isWithSuffixTrie

public boolean isWithSuffixTrie()

Check if suffix trie is enabled.

Returns:

true if suffix trie is enabled

buildTypeSpecificArgs

protected void buildTypeSpecificArgs(CommandArgs<?,?> args)

Description copied from class: FieldArgs

Add type-specific arguments to the command. Subclasses should override this method to add their specific arguments.

Specified by:

buildTypeSpecificArgs in class FieldArgs

Parameters:

args - the command arguments to modify