io.lettuce.core.search.arguments

Class TagFieldArgs<K>

java.lang.Object

io.lettuce.core.search.arguments.FieldArgs<K>

io.lettuce.core.search.arguments.TagFieldArgs<K>

Type Parameters:

K - Key type

public class TagFieldArgs<K>
extends FieldArgs<K>

Field arguments for TAG fields in a RediSearch index.

Tag fields are used to store textual data that represents a collection of data tags or labels. Tag fields are characterized by their low cardinality, meaning they typically have a limited number of distinct values. Unlike text fields, tag fields are stored as-is without tokenization or stemming. They are useful for organizing and categorizing data, making it easier to filter and retrieve documents based on specific tags.

Since:

6.8

Author:

Tihomir Mateev

See Also:

Tag Fields

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TagFieldArgs.Builder<K> Builder for TagFieldArgs.

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
TagFieldArgs()

Method Summary

Modifier and Type	Method and Description
static <K> TagFieldArgs.Builder<K>	builder() Create a new TagFieldArgs using the builder pattern.
protected void	buildTypeSpecificArgs(CommandArgs<K,?> args) Add type-specific arguments to the command.
String	getFieldType() Returns the field type.
Optional<String>	getSeparator() Get the separator for tag fields.
boolean	isCaseSensitive() Check if the field is case sensitive.
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

TagFieldArgs

public TagFieldArgs()

Method Detail

builder

public static <K> TagFieldArgs.Builder<K> builder()

Create a new TagFieldArgs using the builder pattern.

Type Parameters:

K - Key type

Returns:

a new TagFieldArgs.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<K>

Returns:

the field type

getSeparator

public Optional<String> getSeparator()

Get the separator for tag fields.

Returns:

the separator

isCaseSensitive

public boolean isCaseSensitive()

Check if the field is case sensitive.

Returns:

true if case sensitive

isWithSuffixTrie

public boolean isWithSuffixTrie()

Check if suffix trie is enabled.

Returns:

true if suffix trie is enabled

buildTypeSpecificArgs

protected void buildTypeSpecificArgs(CommandArgs<K,?> 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<K>

Parameters:

args - the command arguments to modify