io.lettuce.core.search.arguments

Class AggregateArgs

java.lang.Object

io.lettuce.core.search.arguments.AggregateArgs

public class AggregateArgs
extends Object

Argument list builder for FT.AGGREGATE command.

FT.AGGREGATE runs a search query on an index and performs aggregate transformations on the results. It provides a powerful aggregation pipeline that can group, sort, apply mathematical expressions, filter, and limit results in a single command.

Basic Usage:

 
 {
     @code
     // Simple aggregation with grouping and counting
     AggregateArgs args = AggregateArgs.builder().groupBy("category").reduce(Reducer.count().as("count"))
             .sortBy("count", SortDirection.DESC).build();
     SearchReply result = redis.ftAggregate("myindex", "*", args);
 }
 

Advanced Pipeline Example:

 
 {
     @code
     // Complex aggregation pipeline
     AggregateArgs args = AggregateArgs.builder().load("price", "quantity", "category")
             .apply("@price * @quantity", "total_value").filter("@total_value > 100").groupBy("category")
             .reduce(Reducer.sum("@total_value").as("category_total")).reduce(Reducer.avg("@price").as("avg_price"))
             .sortBy("category_total", SortDirection.DESC).limit(0, 10).dialect(QueryDialects.DIALECT2).build();
 }
 

Supported Operations:

• LOAD - Load document attributes from source documents
• GROUPBY - Group results by one or more properties with reducers
• SORTBY - Sort results by properties with ASC/DESC directions
• APPLY - Apply mathematical expressions to create computed fields
• FILTER - Filter results using predicate expressions
• LIMIT - Limit and paginate results
• WITHCURSOR - Use cursor-based pagination for large result sets

Performance Considerations:

• Attributes used in GROUPBY and SORTBY should be stored as SORTABLE for optimal performance
• LOAD operations can hurt performance as they require HMGET operations on each record
• Use SORTBY with MAX for efficient top-N queries
• Consider using WITHCURSOR for large result sets to avoid memory issues

Since:

6.8

Author:

Tihomir Mateev

See Also:

FT.AGGREGATE, Redis Aggregations Guide

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregateArgs.Apply Represents an APPLY clause in an aggregation pipeline.
static class	AggregateArgs.Builder Builder for AggregateArgs.
static class	AggregateArgs.CollectReducer Represents a REDUCE COLLECT clause in an aggregation pipeline.
static class	AggregateArgs.Filter Represents a FILTER clause in an aggregation pipeline.
static class	AggregateArgs.GroupBy Represents a GROUPBY clause in an aggregation pipeline.
static class	AggregateArgs.Limit
static class	AggregateArgs.LoadField
static interface	AggregateArgs.PipelineOperation Interface for pipeline operations that need to be applied in user-specified order.
static class	AggregateArgs.Reducer Represents a REDUCE function in a GROUPBY clause.
static class	AggregateArgs.SortBy Represents a SORTBY clause in an aggregation pipeline.
static class	AggregateArgs.SortDirection Sort direction enumeration.
static class	AggregateArgs.SortProperty Represents a sort property with direction.
static class	AggregateArgs.WithCursor

Constructor Summary

Constructors

Constructor and Description
AggregateArgs()

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<?,?> args) Build a CommandArgs object that contains all the arguments.
static AggregateArgs.Builder	builder() Creates a new AggregateArgs instance.
Optional<AggregateArgs.WithCursor>	getWithCursor()

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateArgs

public AggregateArgs()

Method Detail

builder

public static AggregateArgs.Builder builder()

Creates a new AggregateArgs instance.

Returns:

new instance of AggregateArgs.

build

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

Build a CommandArgs object that contains all the arguments.

Parameters:

args - the CommandArgs object

getWithCursor

public Optional<AggregateArgs.WithCursor> getWithCursor()