AggregateArgs.Builder (Lettuce 7.8.0.RELEASE API)

java.lang.Object
- io.lettuce.core.search.arguments.AggregateArgs.Builder

Enclosing class:: AggregateArgs

public static class AggregateArgs.Builder
extends Object

Builder for AggregateArgs.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AggregateArgs.Builder`	`addScores()` Set ADDSCORES flag to expose full-text search scores.
`AggregateArgs.Builder`	`apply(AggregateArgs.Apply apply)` Add an APPLY clause.
`AggregateArgs.Builder`	`apply(String expression, String name)` Convenience method to add an APPLY clause.
`AggregateArgs`	`build()` Build the `AggregateArgs`.
`AggregateArgs.Builder`	`dialect(QueryDialects dialect)` Set the query dialect.
`AggregateArgs.Builder`	`filter(String filter)` Add a FILTER clause for post-aggregation filtering.
`AggregateArgs.Builder`	`groupBy(AggregateArgs.GroupBy groupBy)` Add a GROUPBY clause.
`AggregateArgs.Builder`	`groupBy(String... properties)` Convenience method to add a GROUPBY clause with properties.
`AggregateArgs.Builder`	`limit(long offset, long num)` Set LIMIT clause for pagination.
`AggregateArgs.Builder`	`load(String field)` Load document attributes from the source document.
`AggregateArgs.Builder`	`load(String field, String alias)` Load document attributes from the source document with alias.
`AggregateArgs.Builder`	`loadAll()` Load all document attributes.
`AggregateArgs.Builder`	`param(String name, byte[] value)` Add a binary query parameter, for example the query vector of a KNN clause (`*=>[KNN 10 @embedding $vec]`).
`AggregateArgs.Builder`	`param(String name, String value)` Add a query parameter.
`AggregateArgs.Builder`	`scorer(String scorer)` Set SCORER clause.
`AggregateArgs.Builder`	`sortBy(AggregateArgs.SortBy sortBy)` Add a SORTBY clause.
`AggregateArgs.Builder`	`sortBy(String property, AggregateArgs.SortDirection direction)` Convenience method to add a SORTBY clause with a single property.
`AggregateArgs.Builder`	`timeout(Duration timeout)` Set timeout for the aggregate operation.
`AggregateArgs.Builder`	`verbatim()` Set VERBATIM flag - do not try to use stemming for query expansion.
`AggregateArgs.Builder`	`withCursor(AggregateArgs.WithCursor withCursor)` Set WITHCURSOR clause for cursor-based pagination.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - verbatim
```
public AggregateArgs.Builder verbatim()
```
    Set VERBATIM flag - do not try to use stemming for query expansion.
    When set, the query terms are searched verbatim without attempting to use stemming for query expansion. This is useful when you want exact matches for your search terms.
    
    Returns:
    
    the builder.
  - load
```
public AggregateArgs.Builder load(String field)
```
    Load document attributes from the source document.
    Loads the specified field from the source document. For hash documents, this is the field name. For JSON documents, this can be a JSONPath expression.
    
    Performance Note: LOAD operations can significantly hurt performance as they require HMGET operations on each processed record. Consider storing frequently accessed attributes as SORTABLE for better performance.
    
    Parameters:
    
    field - the field identifier (field name for hashes, JSONPath for JSON)
    
    Returns:
    
    the builder.
  - load
```
public AggregateArgs.Builder load(String field,
                                  String alias)
```
    Load document attributes from the source document with alias.
    Loads the specified field from the source document and assigns it an alias name for use in the aggregation pipeline. The alias can be referenced in subsequent GROUPBY, SORTBY, APPLY, and FILTER operations.
    
    Parameters:
    
    field - the field identifier (field name for hashes, JSONPath for JSON)
    
    alias - the alias name to use in the result
    
    Returns:
    
    the builder.
  - loadAll
```
public AggregateArgs.Builder loadAll()
```
    Load all document attributes.
    Equivalent to using LOAD * in the Redis command. This loads all attributes from the source documents. Use with caution as this can significantly impact performance when dealing with large documents or many results.
    
    Returns:
    
    the builder.
  - timeout
```
public AggregateArgs.Builder timeout(Duration timeout)
```
    Set timeout for the aggregate operation.
    
    Parameters:
    
    timeout - the timeout duration
    
    Returns:
    
    the builder.
  - groupBy
```
public AggregateArgs.Builder groupBy(AggregateArgs.GroupBy groupBy)
```
    Add a GROUPBY clause.
    
    Parameters:
    
    groupBy - the group by specification
    
    Returns:
    
    the builder.
  - sortBy
```
public AggregateArgs.Builder sortBy(AggregateArgs.SortBy sortBy)
```
    Add a SORTBY clause.
    
    Parameters:
    
    sortBy - the sort by specification
    
    Returns:
    
    the builder.
  - apply
```
public AggregateArgs.Builder apply(AggregateArgs.Apply apply)
```
    Add an APPLY clause.
    
    Parameters:
    
    apply - the apply specification
    
    Returns:
    
    the builder.
  - limit
```
public AggregateArgs.Builder limit(long offset,
                                   long num)
```
    Set LIMIT clause for pagination.
    Limits the number of results to return just num results starting at index offset (zero-based). This is useful for pagination of results.
    
    Performance Note: It is much more efficient to use SORTBY ... MAX if you are only interested in limiting the output of a sort operation. Use LIMIT for pagination or when you need results without sorting.
    
    Example:
```
 
 // Get results 50-100 of the top 100 results efficiently
 .sortBy("score", SortDirection.DESC).max(100)
 .limit(50, 50)
 
 
```
    Parameters:
    
    offset - the zero-based starting index
    
    num - the maximum number of results to return
    
    Returns:
    
    the builder.
  - filter
```
public AggregateArgs.Builder filter(String filter)
```
    Add a FILTER clause for post-aggregation filtering.
    Filters the results using predicate expressions relating to values in each result. Filters are applied after the query and relate to the current state of the pipeline. This allows filtering on computed fields created by APPLY operations or reducer results.
    
    Example Usage:
```
 
 // Filter by numeric comparison
 .filter("@price > 100")

 // Filter by computed field
 .apply("@price * @quantity", "total_value")
 .filter("@total_value > 1000")

 // Filter by reducer result
 .groupBy("category").reduce(Reducer.count().as("count"))
 .filter("@count >= 5")
 
 
```
    Parameters:
    
    filter - the filter expression (e.g., "@price > 100", "@category == 'electronics'")
    
    Returns:
    
    the builder.
  - withCursor
```
public AggregateArgs.Builder withCursor(AggregateArgs.WithCursor withCursor)
```
    Set WITHCURSOR clause for cursor-based pagination.
    Enables cursor-based pagination as a quicker alternative to LIMIT for scanning through large result sets. This is particularly useful when you need to process all results but want to avoid memory issues with very large datasets.
    
    Example Usage:
```
 
 // Basic cursor with read size
 .withCursor(WithCursor.of(1000L))

 // Cursor with read size and idle timeout
 .withCursor(WithCursor.of(1000L, Duration.ofMinutes(5)))
 
 
```
    Use RediSearchCommands.ftCursorread(String, AggregationReply.Cursor, int) and RediSearchCommands.ftCursordel(String, AggregationReply.Cursor) to iterate through and manage the cursor.
    Parameters:
    
    withCursor - the cursor specification with count and optional idle timeout
    
    Returns:
    
    the builder.
  - param
```
public AggregateArgs.Builder param(String name,
                                   String value)
```
    Add a query parameter. The query references it as $name and the server substitutes the value wherever that reference appears, so values need no escaping and cannot alter the query structure, for example param("category", "electronics") with the query @category:{$category}. The value is sent as UTF-8 text. Adding a parameter with the same name again replaces its value.
    Requires QueryDialects.DIALECT2 or higher.
    
    Parameters:
    
    name - the parameter name, referenced as $name in the query, must not be null
    
    value - the parameter value, must not be null
    
    Returns:
    
    the builder.
  - param
```
public AggregateArgs.Builder param(String name,
                                   byte[] value)
```
    Add a binary query parameter, for example the query vector of a KNN clause (*=>[KNN 10 @embedding $vec]). The bytes are sent exactly as given, which the String overload cannot do for arbitrary binary data. The query references the parameter as $name; adding a parameter with the same name again replaces its value.
    Requires QueryDialects.DIALECT2 or higher.
    
    Parameters:
    
    name - the parameter name, referenced as $name in the query, must not be null
    
    value - the binary parameter value, sent as-is, must not be null
    
    Returns:
    
    the builder.
    
    Since:
    
    7.8
  - scorer
```
public AggregateArgs.Builder scorer(String scorer)
```
    Set SCORER clause.
    
    Parameters:
    
    scorer - the scorer function
    
    Returns:
    
    the builder.
  - addScores
```
public AggregateArgs.Builder addScores()
```
    Set ADDSCORES flag to expose full-text search scores.
    The ADDSCORES option exposes the full-text score values to the aggregation pipeline. You can then use @__score in subsequent pipeline operations like SORTBY, APPLY, FILTER, and GROUPBY.
    
    Example Usage:
```
 
 // Sort by search relevance score
 AggregateArgs.builder()
     .addScores()
     .sortBy("__score", SortDirection.DESC)
     .build();

 // Filter by minimum score threshold
 AggregateArgs.builder()
     .addScores()
     .filter("@__score > 0.5")
     .build();
 
 
```
    Returns:
    
    the builder.
  - dialect
```
public AggregateArgs.Builder dialect(QueryDialects dialect)
```
    Set the query dialect.
    
    Parameters:
    
    dialect - the query dialect
    
    Returns:
    
    the builder.
  - groupBy
```
@SafeVarargs
public final AggregateArgs.Builder groupBy(String... properties)
```
    Convenience method to add a GROUPBY clause with properties.
    
    Parameters:
    
    properties - the properties to group by
    
    Returns:
    
    the builder.
  - sortBy
```
public AggregateArgs.Builder sortBy(String property,
                                    AggregateArgs.SortDirection direction)
```
    Convenience method to add a SORTBY clause with a single property.
    
    Parameters:
    
    property - the property to sort by
    
    direction - the sort direction
    
    Returns:
    
    the builder.
  - apply
```
public AggregateArgs.Builder apply(String expression,
                                   String name)
```
    Convenience method to add an APPLY clause.
    
    Parameters:
    
    expression - the expression to apply
    
    name - the result field name
    
    Returns:
    
    the builder.
  - build
```
public AggregateArgs build()
```
    Build the AggregateArgs.
    
    Returns:
    
    the built AggregateArgs.

Class AggregateArgs.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

verbatim

load

load

loadAll

timeout

groupBy

sortBy

apply

limit

Example:

filter

Example Usage:

withCursor

Example Usage:

param

param

scorer

addScores

Example Usage:

dialect

groupBy

sortBy

apply

build