redis.clients.jedis.search.aggr

Class AggregateIterator

java.lang.Object

redis.clients.jedis.search.aggr.AggregateIterator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator<AggregationResult>

public class AggregateIterator
extends java.lang.Object
implements java.util.Iterator<AggregationResult>, java.io.Closeable

Iterator for Redis search aggregation results with cursor support. This class manages the connection to a specific Redis node and handles cursor-based pagination for large aggregation results.

The iterator supports the remove() method which deletes the cursor on the server and terminates the iteration, freeing server resources immediately.

This implementation uses connection pooling to prevent connection pool exhaustion during long-running aggregation operations. Connections are borrowed from the pool for each batch operation and returned immediately after use.

Usage example:

 {
   @code
   // 100 results per batch, 60 second TTL for the cursor
   AggregationBuilder aggr = new AggregationBuilder().groupBy("@field").cursor(100, 60000);

   try (AggregateIterator iterator = new AggregateIterator(provider, "myindex", aggr)) {
     while (iterator.hasNext()) {
       AggregationResult batch = iterator.next();

       if (batch.isEmpty()) {
         break; // FT.AGGREGATE returned empty result set
       }

       // Process batch - access rows via batch.getRows()

       // Optionally terminate early and free server resources
       if (someCondition) {
         iterator.remove(); // Deletes cursor and stops iteration
         break;
       }
     }
   }
 }
 

Constructor Summary

Constructors

Constructor and Description
AggregateIterator(ConnectionProvider connectionProvider, java.lang.String indexName, AggregationBuilder aggregationBuilder) Creates a new AggregateIterator.

Method Summary

Modifier and Type	Method and Description
void	close()
java.lang.Long	getCursorId() Returns the current cursor ID.
boolean	hasNext()
AggregationResult	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

AggregateIterator

public AggregateIterator(ConnectionProvider connectionProvider,
                         java.lang.String indexName,
                         AggregationBuilder aggregationBuilder)

Creates a new AggregateIterator.

Parameters:

connectionProvider - the connection provider for cluster/standalone Redis

indexName - the search index name

aggregationBuilder - the aggregation query with cursor configuration

Throws:

java.lang.IllegalArgumentException - if aggregation doesn't have cursor configured

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<AggregationResult>

next

public AggregationResult next()

Specified by:

next in interface java.util.Iterator<AggregationResult>

getCursorId

public java.lang.Long getCursorId()

Returns the current cursor ID.

Returns:

cursor ID, or null if not initialized

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<AggregationResult>

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable