io.valkey.search.schemafields

Class TagField

java.lang.Object

io.valkey.search.schemafields.SchemaField

io.valkey.search.schemafields.TagField

All Implemented Interfaces:

IParams

public class TagField
extends SchemaField

Field Summary

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

fieldName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
TagField	as(String attribute)
TagField	caseSensitive() Keeps the original letter cases of the tags.
TagField	noIndex() Avoid indexing.
static TagField	of(FieldName fieldName)
static TagField	of(String fieldName)
TagField	separator(char separator) Indicates how the text contained in the attribute is to be split into individual tags.
TagField	sortable() Sorts the results by the value of this field.
TagField	sortableUNF() Sorts the results by the value of this field without normalization.
TagField	sortableUnNormalizedForm()
TagField	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

TagField

public TagField(String fieldName)

TagField

public TagField(FieldName fieldName)

Method Detail

of

public static TagField of(String fieldName)

of

public static TagField of(FieldName fieldName)

as

public TagField as(String attribute)

Overrides:

as in class SchemaField

sortable

public TagField sortable()

Sorts the results by the value of this field.

sortableUNF

public TagField sortableUNF()

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

sortableUnNormalizedForm

public TagField sortableUnNormalizedForm()

See Also:

TextField.sortableUNF()

noIndex

public TagField noIndex()

Avoid indexing.

separator

public TagField separator(char separator)

Indicates how the text contained in the attribute is to be split into individual tags.

caseSensitive

public TagField caseSensitive()

Keeps the original letter cases of the tags.

withSuffixTrie

public TagField 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)