io.valkey.search.schemafields

Class TextField

java.lang.Object

io.valkey.search.schemafields.SchemaField

io.valkey.search.schemafields.TextField

All Implemented Interfaces:

IParams

public class TextField
extends SchemaField

Field Summary

Fields inherited from class io.valkey.search.schemafields.SchemaField

fieldName

Constructor Summary

Constructors

Constructor and Description
TextField(FieldName fieldName)
TextField(String fieldName)

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
TextField	as(String attribute)
TextField	noIndex() Avoid indexing.
TextField	noStem() Disable stemming when indexing.
static TextField	of(FieldName fieldName)
static TextField	of(String fieldName)
TextField	phonetic(String matcher) Perform phonetic matching.
TextField	sortable() Sorts the results by the value of this field.
TextField	sortableUNF() Sorts the results by the value of this field without normalization.
TextField	sortableUnNormalizedForm()
TextField	weight(double weight) Declares the importance of this attribute when calculating result accuracy.
TextField	withSuffixTrie() Keeps a suffix trie with all terms which match the suffix.

Methods inherited from class io.valkey.search.schemafields.SchemaField

getFieldName, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

TextField

public TextField(String fieldName)

TextField

public TextField(FieldName fieldName)

Method Detail

of

public static TextField of(String fieldName)

of

public static TextField of(FieldName fieldName)

as

public TextField as(String attribute)

Overrides:

as in class SchemaField

sortable

public TextField sortable()

Sorts the results by the value of this field.

sortableUNF

public TextField sortableUNF()

Sorts the results by the value of this field without normalization.

sortableUnNormalizedForm

public TextField sortableUnNormalizedForm()

See Also:

sortableUNF()

noStem

public TextField noStem()

Disable stemming when indexing.

noIndex

public TextField noIndex()

Avoid indexing.

phonetic

public TextField phonetic(String matcher)

Perform phonetic matching.

weight

public TextField weight(double weight)

Declares the importance of this attribute when calculating result accuracy. This is a multiplication factor.

withSuffixTrie

public TextField withSuffixTrie()

Keeps a suffix trie with all terms which match the suffix. It is used to optimize contains and suffix queries.

addParams

public void addParams(CommandArguments args)