io.valkey.search.aggr

Class AggregationBuilder

java.lang.Object

io.valkey.search.aggr.AggregationBuilder

All Implemented Interfaces:

IParams

public class AggregationBuilder
extends Object
implements IParams

Author:

Guy Korland

Constructor Summary

Constructors

Constructor and Description
AggregationBuilder()
AggregationBuilder(String query)

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments commArgs)
AggregationBuilder	apply(String projection, String alias)
AggregationBuilder	cursor(int count)
AggregationBuilder	cursor(int count, long maxIdle)
AggregationBuilder	dialect(int dialect)
AggregationBuilder	dialectOptional(int dialect) This method will not replace the dialect if it has been already set.
AggregationBuilder	filter(String expression)
AggregationBuilder	groupBy(Collection<String> fields, Collection<Reducer> reducers)
AggregationBuilder	groupBy(Group group)
AggregationBuilder	groupBy(String field, Reducer... reducers)
boolean	isWithCursor()
AggregationBuilder	limit(int count)
AggregationBuilder	limit(int offset, int count)
AggregationBuilder	load(FieldName... fields)
AggregationBuilder	load(String... fields)
AggregationBuilder	loadAll()
AggregationBuilder	params(Map<String,Object> params)
AggregationBuilder	sortBy(int max, SortedField... fields) Shortcut to sortBy(SortedField...) and sortByMax(int).
AggregationBuilder	sortBy(SortedField... fields)
AggregationBuilder	sortByAsc(String field)
AggregationBuilder	sortByDesc(String field)
AggregationBuilder	sortByMax(int max) sortBy(SortedField...) (or sortByAsc(java.lang.String) or sortByDesc(java.lang.String)) MUST BE called JUST BEFORE this.
AggregationBuilder	timeout(long timeout)
AggregationBuilder	verbatim()

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregationBuilder

public AggregationBuilder(String query)

AggregationBuilder

public AggregationBuilder()

Method Detail

load

public AggregationBuilder load(String... fields)

load

public AggregationBuilder load(FieldName... fields)

loadAll

public AggregationBuilder loadAll()

limit

public AggregationBuilder limit(int offset,
                                int count)

limit

public AggregationBuilder limit(int count)

sortBy

public AggregationBuilder sortBy(SortedField... fields)

sortByAsc

public AggregationBuilder sortByAsc(String field)

sortByDesc

public AggregationBuilder sortByDesc(String field)

sortByMax

public AggregationBuilder sortByMax(int max)

sortBy(SortedField...) (or sortByAsc(java.lang.String) or sortByDesc(java.lang.String)) MUST BE called JUST BEFORE this.

Parameters:

max - limit

Returns:

this

sortBy

public AggregationBuilder sortBy(int max,
                                 SortedField... fields)

Shortcut to sortBy(SortedField...) and sortByMax(int).

Parameters:

max - limit

fields - sorted fields

Returns:

this

apply

public AggregationBuilder apply(String projection,
                                String alias)

groupBy

public AggregationBuilder groupBy(Group group)

groupBy

public AggregationBuilder groupBy(Collection<String> fields,
                                  Collection<Reducer> reducers)

groupBy

public AggregationBuilder groupBy(String field,
                                  Reducer... reducers)

filter

public AggregationBuilder filter(String expression)

cursor

public AggregationBuilder cursor(int count)

cursor

public AggregationBuilder cursor(int count,
                                 long maxIdle)

verbatim

public AggregationBuilder verbatim()

timeout

public AggregationBuilder timeout(long timeout)

params

public AggregationBuilder params(Map<String,Object> params)

dialect

public AggregationBuilder dialect(int dialect)

dialectOptional

public AggregationBuilder dialectOptional(int dialect)

This method will not replace the dialect if it has been already set.

Parameters:

dialect - dialect

Returns:

this

isWithCursor

public boolean isWithCursor()

addParams

public void addParams(CommandArguments commArgs)

Specified by:

addParams in interface IParams