io.lettuce.core.search.aggregateutils

Enum ReduceFunction

java.lang.Object

java.lang.Enum<ReduceFunction>

io.lettuce.core.search.aggregateutils.ReduceFunction

All Implemented Interfaces:

ProtocolKeyword, Serializable, Comparable<ReduceFunction>

@Experimental
public enum ReduceFunction
extends Enum<ReduceFunction>
implements ProtocolKeyword

Enumeration of REDUCE functions for GROUPBY operations in FT.HYBRID and FT.AGGREGATE commands.

Since:

7.5

Author:

Aleksandar Todorov

See Also:

Reducer, GroupBy

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVG Calculate the average of numeric values.
COUNT Count the number of records in the group.
COUNT_DISTINCT Count unique values of a field.
COUNT_DISTINCTISH Approximate count of unique values using HyperLogLog algorithm.
FIRST_VALUE Get the first value in the group.
MAX Find the maximum value.
MIN Find the minimum value.
QUANTILE Calculate quantile/percentile (e.g., median at 0.5).
RANDOM_SAMPLE Random sampling from the group.
STDDEV Calculate standard deviation.
SUM Sum all numeric values of a field.
TOLIST Collect all values into a list.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes()
static ReduceFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReduceFunction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.lettuce.core.protocol.ProtocolKeyword

name, toString

Enum Constant Detail

COUNT

public static final ReduceFunction COUNT

Count the number of records in the group.

COUNT_DISTINCT

public static final ReduceFunction COUNT_DISTINCT

Count unique values of a field.

COUNT_DISTINCTISH

public static final ReduceFunction COUNT_DISTINCTISH

Approximate count of unique values using HyperLogLog algorithm.

SUM

public static final ReduceFunction SUM

Sum all numeric values of a field.

AVG

public static final ReduceFunction AVG

Calculate the average of numeric values.

MIN

public static final ReduceFunction MIN

Find the minimum value.

MAX

public static final ReduceFunction MAX

Find the maximum value.

STDDEV

public static final ReduceFunction STDDEV

Calculate standard deviation.

QUANTILE

public static final ReduceFunction QUANTILE

Calculate quantile/percentile (e.g., median at 0.5).

TOLIST

public static final ReduceFunction TOLIST

Collect all values into a list.

FIRST_VALUE

public static final ReduceFunction FIRST_VALUE

Get the first value in the group.

RANDOM_SAMPLE

public static final ReduceFunction RANDOM_SAMPLE

Random sampling from the group.

Method Detail

values

public static ReduceFunction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReduceFunction c : ReduceFunction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReduceFunction valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getBytes

public byte[] getBytes()

Specified by:

getBytes in interface ProtocolKeyword

Returns:

byte[] encoded representation.