io.lettuce.core.search.arguments

Class AggregateArgs.Apply

java.lang.Object

io.lettuce.core.search.arguments.AggregateArgs.Apply

All Implemented Interfaces:

AggregateArgs.PipelineOperation

Enclosing class:

AggregateArgs

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

Represents an APPLY clause in an aggregation pipeline.

Applies a 1-to-1 transformation on one or more properties and either stores the result as a new property down the pipeline or replaces any property using this transformation. APPLY can perform arithmetic operations on numeric properties or apply functions depending on property types.

Example Usage:

 
 {
     @code
     // Calculate total value from price and quantity
     Apply totalValue = new Apply("@price * @quantity", "total_value");

     // Mathematical operations
     Apply discount = new Apply("@price * 0.9", "discounted_price");

     // String operations
     Apply fullName = new Apply("@first_name + ' ' + @last_name", "full_name");

     // Date operations
     Apply dayOfWeek = new Apply("day(@timestamp)", "day");
 }
 

Supported Operations:

• Arithmetic: +, -, *, /, %, ^
• Mathematical functions: sqrt(), log(), abs(), ceil(), floor()
• String functions: upper(), lower(), substr()
• Date functions: day(), hour(), minute(), month(), year()
• Geo functions: geodistance()

The expression is evaluated dynamically for each record in the pipeline and the result is stored as a new property that can be referenced by further operations.

Constructor Summary

Constructors

Constructor and Description
Apply(String expression, String name)

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<?,?> args) Build the operation arguments into the command args.
static AggregateArgs.Apply	of(String expression, String name) Static factory method to create an Apply instance with a single name and expression pair.

Methods inherited from class java.lang.Object

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

Constructor Detail

Apply

public Apply(String expression,
             String name)

Method Detail

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

of

public static AggregateArgs.Apply of(String expression,
                                     String name)

Static factory method to create an Apply instance with a single name and expression pair.

Parameters:

name - the name of the expression

expression - the expression to apply

Returns:

new Apply instance