ElasticQuery (SIRIUS db 5.0-rc9 API)

java.lang.Object
- sirius.db.mixing.query.BaseQuery<Q,E>
- - sirius.db.mixing.query.Query<ElasticQuery<E>,E,ElasticConstraint>
  - - sirius.db.es.ElasticQuery<E>

Type Parameters:: E - the type of entities to be queried

public class ElasticQuery<E extends ElasticEntity>
extends Query<ElasticQuery<E>,E,ElasticConstraint>

Provides a fluent query API for Elasticsearch.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ElasticQuery.InnerHitsBuilder
Used to describe inner hits which are determine for field collapsing.

Nested Classes
Modifier and Type	Class and Description
`class`	`ElasticQuery.InnerHitsBuilder` Used to describe inner hits which are determine for field collapsing.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_TERM_AGGREGATION_BUCKET_COUNT
Contains the default number of buckets being collected and reported for an aggregation.
- Fields inherited from class sirius.db.mixing.query.BaseQuery
  descriptor, limit, MAX_LIST_SIZE, mixing, skip

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_TERM_AGGREGATION_BUCKET_COUNT` Contains the default number of buckets being collected and reported for an aggregation.

Constructor Summary

Constructors
Constructor and Description

ElasticQuery(EntityDescriptor descriptor, LowLevelClient client)
Creates a new query for the given type using the given client.

Constructors
Constructor and Description
`ElasticQuery(EntityDescriptor descriptor, LowLevelClient client)` Creates a new query for the given type using the given client.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ElasticQuery<E>`	`addAggregation(String name, com.alibaba.fastjson.JSONObject aggregation)` Adds the given aggregation for the given name.
`ElasticQuery.InnerHitsBuilder`	`addCollapsedInnerHits(String name, int size)` Adds a description to obtain a sublist of collapsed results.
`ElasticQuery<E>`	`addDateAggregation(String name, Mapping field, List<DateRange> ranges)` Adds a date (bucket) aggregation.
`ElasticQuery<E>`	`addTermAggregation(Mapping field)` Adds a term (bucket) aggregation for the given field.
`ElasticQuery<E>`	`addTermAggregation(String name, Mapping field, int size)` Adds a term (bucket) aggregation for the given field.
`ElasticQuery<E>`	`collapse(Mapping field)` Collapses by the given field.
`ElasticQuery<E>`	`collapse(String field)` Collapses by the given field.
`void`	`computeAggregations()` Executes a request which just contains aggregations and will not fetch any search items in the request body.
`long`	`count()` Executes the query and counts the number of results.
`void`	`delete()` Deletes all matches using the `BaseMapper.delete(BaseEntity)` of the appropriate mapper.
`ElasticQuery<E>`	`deliberatelyUnrouted()` Signals the the routing is deliberately skipped as no routing value is available.
`boolean`	`exists()` Determines if the query would have at least one matching entity.
`ElasticQuery<E>`	`filter(com.alibaba.fastjson.JSONObject filter)` Adds a FILTER constraint to the query.
`FilterFactory<ElasticConstraint>`	`filters()`
`List<sirius.kernel.commons.Tuple<String,Integer>>`	`getAggregationBuckets(String name)` Returns the buckets which were computed as an aggregation while executing the query.
`void`	`iterate(Function<E,Boolean> handler)` Calls the given function on all items in the result, as long as it returns `true`.
`ElasticQuery<E>`	`must(ElasticConstraint filter)` Adds a MUST filter to the query.
`ElasticQuery<E>`	`must(com.alibaba.fastjson.JSONObject filter)` Adds a MUST filter to the query.
`ElasticQuery<E>`	`mustNot(ElasticConstraint filter)` Adds a MUST NOT filter to the query.
`ElasticQuery<E>`	`mustNot(com.alibaba.fastjson.JSONObject filter)` Adds a MUST NOT filter to the query.
`ElasticQuery<E>`	`orderAsc(Mapping field)` Adds an ascending sort by the given field to the query.
`ElasticQuery<E>`	`orderDesc(Mapping field)` Adds a descending sort by the given field to the query.
`ElasticQuery<E>`	`postFilter(ElasticConstraint filter)` Adds a post filter to the query.
`ElasticQuery<E>`	`postFilter(com.alibaba.fastjson.JSONObject filter)` Adds a post filterto the query.
`ElasticQuery<E>`	`routing(String value)` Specifies the routing value to use.
`ElasticQuery<E>`	`sort(com.alibaba.fastjson.JSONObject sortSpec)` Adds a sort statement to the query.
`ElasticQuery<E>`	`sort(Mapping field, com.alibaba.fastjson.JSONObject sortSpec)` Adds a sort statement for the given field to the query.
`String`	`toString()`
`void`	`truncate()` Deletes all matches using the capabilities of the underlying database.
`ElasticQuery<E>`	`where(ElasticConstraint constraint)` Applies the given contraints to the query.
`ElasticQuery<E>`	`years(int... years)` Specifies which years to query for entities which are `stored per year`.
`ElasticQuery<E>`	`yearsFromTo(int from, int to)` Specifies a range of years to query for entities which are `stored per year`.

Methods inherited from class sirius.db.mixing.query.Query
eq, eqIgnoreNull, ne, queryString

Methods inherited from class sirius.db.mixing.query.BaseQuery
failOnOverflow, first, getDescriptor, getLimit, iterateAll, limit, one, queryFirst, queryList, queryOne, skip

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

- Field Detail
  - DEFAULT_TERM_AGGREGATION_BUCKET_COUNT
```
public static final int DEFAULT_TERM_AGGREGATION_BUCKET_COUNT
```
    Contains the default number of buckets being collected and reported for an aggregation.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ElasticQuery
```
public ElasticQuery(EntityDescriptor descriptor,
                    LowLevelClient client)
```
    Creates a new query for the given type using the given client.
    
    Parameters:
    
    descriptor - the descriptor of the entity type to query
    
    client - the client to use
    
    See Also:
    
    Elastic.select(Class)
- Method Detail
  - years
```
public ElasticQuery<E> years(int... years)
```
    Specifies which years to query for entities which are stored per year.
    
    Parameters:
    
    years - a list of years to search in. Note that years for which no index exists will be filtered automatically
    
    Returns:
    
    the query itself for fluent method calls
  - yearsFromTo
```
public ElasticQuery<E> yearsFromTo(int from,
                                   int to)
```
    Specifies a range of years to query for entities which are stored per year.
    Note that years for which no index exists will be filtered automatically
    
    Parameters:
    
    from - the first year to search in
    
    to - the last year to search in
    
    Returns:
    
    the query itself for fluent method calls
  - must
```
public ElasticQuery<E> must(com.alibaba.fastjson.JSONObject filter)
```
    Adds a MUST filter to the query.
    
    Parameters:
    
    filter - the filter to add
    
    Returns:
    
    the query itself for fluent method calls
  - must
```
public ElasticQuery<E> must(ElasticConstraint filter)
```
    Adds a MUST filter to the query.
    
    Parameters:
    
    filter - the filter to add
    
    Returns:
    
    the query itself for fluent method calls
  - mustNot
```
public ElasticQuery<E> mustNot(com.alibaba.fastjson.JSONObject filter)
```
    Adds a MUST NOT filter to the query.
    
    Parameters:
    
    filter - the filter to add
    
    Returns:
    
    the query itself for fluent method calls
  - mustNot
```
public ElasticQuery<E> mustNot(ElasticConstraint filter)
```
    Adds a MUST NOT filter to the query.
    
    Parameters:
    
    filter - the filter to add
    
    Returns:
    
    the query itself for fluent method calls
  - filter
```
public ElasticQuery<E> filter(com.alibaba.fastjson.JSONObject filter)
```
    Adds a FILTER constraint to the query.
    
    Parameters:
    
    filter - the filter to add
    
    Returns:
    
    the query itself for fluent method calls
    
    See Also:
    
    BoolQueryBuilder.filter(JSONObject)
  - where
```
public ElasticQuery<E> where(ElasticConstraint constraint)
```
    Description copied from class: Query
    
    Applies the given contraints to the query.
    
    Specified by:
    
    where in class Query<ElasticQuery<E extends ElasticEntity>,E extends ElasticEntity,ElasticConstraint>
    
    Parameters:
    
    constraint - the constraint which has to be fullfilled
    
    Returns:
    
    the query itself for fluent method calls
  - postFilter
```
public ElasticQuery<E> postFilter(com.alibaba.fastjson.JSONObject filter)
```
    Adds a post filterto the query.
    
    Parameters:
    
    filter - the filter to add
    
    Returns:
    
    the query itself for fluent method calls
  - postFilter
```
public ElasticQuery<E> postFilter(ElasticConstraint filter)
```
    Adds a post filter to the query.
    
    Parameters:
    
    filter - the filter to add
    
    Returns:
    
    the query itself for fluent method calls
  - sort
```
public ElasticQuery<E> sort(com.alibaba.fastjson.JSONObject sortSpec)
```
    Adds a sort statement to the query.
    
    Parameters:
    
    sortSpec - a JSON object describing a sort requirement
    
    Returns:
    
    the query itself for fluent method calls
  - sort
```
public ElasticQuery<E> sort(Mapping field,
                            com.alibaba.fastjson.JSONObject sortSpec)
```
    Adds a sort statement for the given field to the query.
    
    Parameters:
    
    field - the field to sort by
    
    sortSpec - a JSON object describing a sort requirement
    
    Returns:
    
    the query itself for fluent method calls
  - orderAsc
```
public ElasticQuery<E> orderAsc(Mapping field)
```
    Adds an ascending sort by the given field to the query.
    
    Specified by:
    
    orderAsc in class Query<ElasticQuery<E extends ElasticEntity>,E extends ElasticEntity,ElasticConstraint>
    
    Parameters:
    
    field - the field to order by
    
    Returns:
    
    the query itself for fluent method calls
  - orderDesc
```
public ElasticQuery<E> orderDesc(Mapping field)
```
    Adds a descending sort by the given field to the query.
    
    Specified by:
    
    orderDesc in class Query<ElasticQuery<E extends ElasticEntity>,E extends ElasticEntity,ElasticConstraint>
    
    Parameters:
    
    field - the field to order by
    
    Returns:
    
    the query itself for fluent method calls
  - collapse
```
public ElasticQuery<E> collapse(Mapping field)
```
    Collapses by the given field.
    
    Parameters:
    
    field - the field to collapse results by.
    
    Returns:
    
    the query itself for fluent method calls
  - collapse
```
public ElasticQuery<E> collapse(String field)
```
    Collapses by the given field.
    
    Parameters:
    
    field - the field to collapse results by.
    
    Returns:
    
    the query itself for fluent method calls
  - addCollapsedInnerHits
```
public ElasticQuery.InnerHitsBuilder addCollapsedInnerHits(String name,
                                                           int size)
```
    Adds a description to obtain a sublist of collapsed results.
    
    Parameters:
    
    name - the name of the list
    
    size - the number of results
    
    Returns:
    
    the builder which can be used to control sorting
  - addAggregation
```
public ElasticQuery<E> addAggregation(String name,
                                      com.alibaba.fastjson.JSONObject aggregation)
```
    Adds the given aggregation for the given name.
    
    Parameters:
    
    name - the name of the aggregation
    
    aggregation - the aggregation itself
    
    Returns:
    
    the query itself for fluent method calls
  - addTermAggregation
```
public ElasticQuery<E> addTermAggregation(Mapping field)
```
    Adds a term (bucket) aggregation for the given field.
    
    Parameters:
    
    field - the field to aggregate
    
    Returns:
    
    the query itself for fluent method calls
    
    See Also:
    
    getAggregationBuckets(String)
  - addTermAggregation
```
public ElasticQuery<E> addTermAggregation(String name,
                                          Mapping field,
                                          int size)
```
    Adds a term (bucket) aggregation for the given field.
    
    Parameters:
    
    name - the name of the aggregation
    
    field - the field to aggregate
    
    size - the max. number of buckets to return
    
    Returns:
    
    the query itself for fluent method calls
    
    See Also:
    
    getAggregationBuckets(String)
  - addDateAggregation
```
public ElasticQuery<E> addDateAggregation(String name,
                                          Mapping field,
                                          List<DateRange> ranges)
```
    Adds a date (bucket) aggregation.
    
    Parameters:
    
    name - the name of the aggregation
    
    field - the field to aggregate
    
    ranges - the ranges / buckets to aggregate
    
    Returns:
    
    the query itself for fluent method calls
    
    See Also:
    
    getAggregationBuckets(String)
  - routing
```
public ElasticQuery<E> routing(String value)
```
    Specifies the routing value to use.
    For routed entities it is highly recommended to supply a routing value as it greatly improves the search performance. If no routing value is available, use deliberatelyUnrouted() to signal the the value was deliberately skipped. Otherwise a warning will be emitted to support error tracing.
    
    Parameters:
    
    value - the value to use for routing
    
    Returns:
    
    the query itself for fluent method calls
  - deliberatelyUnrouted
```
public ElasticQuery<E> deliberatelyUnrouted()
```
    Signals the the routing is deliberately skipped as no routing value is available.
    
    Returns:
    
    the query itself for fluent method calls
  - count
```
public long count()
```
    Description copied from class: Query
    
    Executes the query and counts the number of results.
    
    Specified by:
    
    count in class Query<ElasticQuery<E extends ElasticEntity>,E extends ElasticEntity,ElasticConstraint>
    
    Returns:
    
    the number of matched result entries
  - exists
```
public boolean exists()
```
    Description copied from class: Query
    
    Determines if the query would have at least one matching entity.
    
    Specified by:
    
    exists in class Query<ElasticQuery<E extends ElasticEntity>,E extends ElasticEntity,ElasticConstraint>
    
    Returns:
    
    true if at least one entity matches the query, false otherwise.
  - iterate
```
public void iterate(Function<E,Boolean> handler)
```
    Description copied from class: BaseQuery
    
    Calls the given function on all items in the result, as long as it returns true.
    Note that this method is intended for large results as not all items in the result need to be kept in memory when iterating through them.
    
    Specified by:
    
    iterate in class BaseQuery<ElasticQuery<E extends ElasticEntity>,E extends ElasticEntity>
    
    Parameters:
    
    handler - the handle to be invoked for each item in the result
  - computeAggregations
```
public void computeAggregations()
```
    Executes a request which just contains aggregations and will not fetch any search items in the request body.
    The computed aggregations can be read via getAggregationBuckets(String).
  - getAggregationBuckets
```
public List<sirius.kernel.commons.Tuple<String,Integer>> getAggregationBuckets(String name)
```
    Returns the buckets which were computed as an aggregation while executing the query.
    Note that the query has to be executed before calling this method.
    
    Parameters:
    
    name - the aggregation to read
    
    Returns:
    
    the buckets which were computed for the given aggregation
  - delete
```
public void delete()
```
    Description copied from class: Query
    
    Deletes all matches using the BaseMapper.delete(BaseEntity) of the appropriate mapper.
    Be aware that this might be slow for very large result sets.
    
    Specified by:
    
    delete in class Query<ElasticQuery<E extends ElasticEntity>,E extends ElasticEntity,ElasticConstraint>
  - truncate
```
public void truncate()
```
    Description copied from class: Query
    
    Deletes all matches using the capabilities of the underlying database.
    Therefore no checks or anything will be invoked for the deleted entities.
    Use this for larger result sets where integrity and constraints do not matter or are managed manually.
    
    Specified by:
    
    truncate in class Query<ElasticQuery<E extends ElasticEntity>,E extends ElasticEntity,ElasticConstraint>
  - filters
```
public FilterFactory<ElasticConstraint> filters()
```
    Specified by:
    
    filters in class Query<ElasticQuery<E extends ElasticEntity>,E extends ElasticEntity,ElasticConstraint>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ElasticQuery<E extends ElasticEntity>

Nested Class Summary

Field Summary

Fields inherited from class sirius.db.mixing.query.BaseQuery

Constructor Summary

Method Summary

Methods inherited from class sirius.db.mixing.query.Query

Methods inherited from class sirius.db.mixing.query.BaseQuery

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TERM_AGGREGATION_BUCKET_COUNT

Constructor Detail

ElasticQuery

Method Detail

years

yearsFromTo

must

must

mustNot

mustNot

filter

where

postFilter

postFilter

sort

sort

orderAsc

orderDesc

collapse

collapse

addCollapsedInnerHits

addAggregation

addTermAggregation

addTermAggregation

addDateAggregation

routing

deliberatelyUnrouted

count

exists

iterate

computeAggregations

getAggregationBuckets

delete

truncate

filters

toString