io.lettuce.core.search.arguments

Class AggregateArgs.SortBy

java.lang.Object

io.lettuce.core.search.arguments.AggregateArgs.SortBy

All Implemented Interfaces:

AggregateArgs.PipelineOperation

Enclosing class:

AggregateArgs

public static class AggregateArgs.SortBy
extends Object
implements AggregateArgs.PipelineOperation

Represents a SORTBY clause in an aggregation pipeline.

Sorts the pipeline results up until the point of SORTBY, using a list of properties. By default, sorting is ascending, but ASC or DESC can be specified for each property.

Example Usage:

 {
     @code
     // Simple sort by single field
     SortBy sortBy = SortBy.of("price", SortDirection.DESC);

     // Sort with MAX optimization for top-N queries
     SortBy topN = SortBy.of("score", SortDirection.DESC).max(100) // Only sort top 100 results
             .withCount(); // Include accurate count

     // Multiple sort criteria
     SortBy multiSort = SortBy.of(new SortProperty("category", SortDirection.ASC),
             new SortProperty("price", SortDirection.DESC));
 }
 

Performance Optimizations:

• MAX - Optimizes sorting by only processing the top N results
• WITHCOUNT - Returns accurate counts but processes all results
• SORTABLE fields - Use SORTABLE attribute in index for best performance

Performance Note: Use max() for efficient top-N queries instead of sorting all results and then using LIMIT.

Constructor Summary

Constructors

Constructor and Description
SortBy(List<AggregateArgs.SortProperty> properties)

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<?,?> args) Build the operation arguments into the command args.
AggregateArgs.SortBy	max(long max)
static AggregateArgs.SortBy	of(AggregateArgs.SortProperty... properties) Static factory method to create a SortBy instance with multiple properties.
static AggregateArgs.SortBy	of(String property, AggregateArgs.SortDirection direction) Static factory method to create a SortBy instance with a single property.
AggregateArgs.SortBy	withCount()

Methods inherited from class java.lang.Object

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

Constructor Detail

SortBy

public SortBy(List<AggregateArgs.SortProperty> properties)

Method Detail

max

public AggregateArgs.SortBy max(long max)

withCount

public AggregateArgs.SortBy withCount()

of

public static AggregateArgs.SortBy of(String property,
                                      AggregateArgs.SortDirection direction)

Static factory method to create a SortBy instance with a single property.

Parameters:

property - the property to sort by

direction - the sort direction

Returns:

new SortBy instance

of

@SafeVarargs
public static AggregateArgs.SortBy of(AggregateArgs.SortProperty... properties)

Static factory method to create a SortBy instance with multiple properties.

Parameters:

properties - the properties to sort by

Returns:

new SortBy instance

build

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

Description copied from interface: AggregateArgs.PipelineOperation

Build the operation arguments into the command args.

Specified by:

build in interface AggregateArgs.PipelineOperation

Parameters:

args - the command args to build into