io.lettuce.core.search.aggregateutils

Class GroupBy

java.lang.Object

io.lettuce.core.search.aggregateutils.GroupBy

All Implemented Interfaces:

PostProcessingOperation

@Experimental
public class GroupBy
extends Object
implements PostProcessingOperation

GROUPBY post-processing operation. Groups results by one or more properties with reducer functions.

Groups the results in the pipeline based on one or more properties. Each group should have at least one reducer function that handles the group entries, either counting them or performing multiple aggregate operations.

Example Usage:

 {
     @code
     // Group by category and count items
     GroupBy groupBy = GroupBy.of("category").reduce(Reducers.count().as("item_count"));

     // Group by multiple fields with multiple reducers
     GroupBy complexGroup = GroupBy.of("category", "brand").reduce(Reducers.count().as("count"))
             .reduce(Reducers.avg("@price").as("avg_price"));
 }
 

Since:

7.5

Author:

Aleksandar Todorov

See Also:

Reducer, Reducers, ReduceFunction, PostProcessingOperation

Constructor Summary

Constructors

Constructor and Description
GroupBy(List<String> properties) Creates a new GROUPBY operation.

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<?,?> args) Build the operation arguments into the command args.
static GroupBy	of(String... properties) Static factory method to create a GroupBy instance.
GroupBy	reduce(Reducer reducer) Add a reducer to this GROUPBY operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupBy

public GroupBy(List<String> properties)

Creates a new GROUPBY operation.

Parameters:

properties - the properties to group by

Method Detail

of

@SafeVarargs
public static GroupBy of(String... properties)

Static factory method to create a GroupBy instance.

Parameters:

properties - the properties to group by

Returns:

new GroupBy instance

reduce

public GroupBy reduce(Reducer reducer)

Add a reducer to this GROUPBY operation.

Parameters:

reducer - the reducer to add

Returns:

this GroupBy instance

build

public void build(CommandArgs<?,?> args)

Description copied from interface: PostProcessingOperation

Build the operation arguments into the command args.

Specified by:

build in interface PostProcessingOperation

Parameters:

args - the command args to build into