org.springframework.data.elasticsearch.core.query

Class NativeSearchQuery

java.lang.Object

org.springframework.data.elasticsearch.core.query.NativeSearchQuery

All Implemented Interfaces:

Query

public class NativeSearchQuery
extends Object

A query created from Elasticsearch QueryBuilder instances. Note: the filter constructor parameter is used to create a post_filter https://www.elastic.co/guide/en/elasticsearch/reference/7.9/filter-search-results.html#post-filter, if a filter is needed that filters before aggregations are build, it must be included in the query constructor parameter.

Author:

Rizwan Idrees, Mohsin Husen, Artur Konczak, Jean-Baptiste Nizet, Martin Choraine, Peter-Josef Meisch

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	fields
protected HighlightQuery	highlightQuery
protected Collection<String>	ids
protected org.elasticsearch.action.support.IndicesOptions	indicesOptions
protected Integer	maxResults
protected float	minScore
protected Pageable	pageable
protected String	preference
protected String	route
protected org.elasticsearch.action.search.SearchType	searchType
protected Sort	sort
protected SourceFilter	sourceFilter
protected boolean	trackScores

Fields inherited from interface org.springframework.data.elasticsearch.core.query.Query

DEFAULT_PAGE, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query)
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query, org.elasticsearch.index.query.QueryBuilder filter)
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query, org.elasticsearch.index.query.QueryBuilder filter, List<org.elasticsearch.search.sort.SortBuilder<?>> sorts)
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query, org.elasticsearch.index.query.QueryBuilder filter, List<org.elasticsearch.search.sort.SortBuilder<?>> sorts, org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields)
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query, org.elasticsearch.index.query.QueryBuilder filter, List<org.elasticsearch.search.sort.SortBuilder<?>> sorts, org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder highlightBuilder, org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields)

Method Summary

Modifier and Type	Method and Description
void	addAggregation(org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?> aggregationBuilder)
void	addFields(String... fields) Add fields to be added as part of search request
void	addScriptField(ScriptField... scriptField)
<T extends Query> T	addSort(Sort sort) Add Sort to query
void	addSourceFilter(SourceFilter sourceFilter) Add source filter to be added as part of search request
List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>>	getAggregations()
org.elasticsearch.search.collapse.CollapseBuilder	getCollapseBuilder()
List<org.elasticsearch.search.sort.SortBuilder<?>>	getElasticsearchSorts()
List<String>	getFields() Get fields to be returned as part of search request
org.elasticsearch.index.query.QueryBuilder	getFilter()
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder	getHighlightBuilder()
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[]	getHighlightFields()
Optional<HighlightQuery>	getHighlightQuery()
Collection<String>	getIds() Get Ids
List<IndexBoost>	getIndicesBoost()
org.elasticsearch.action.support.IndicesOptions	getIndicesOptions() Get indices options
Integer	getMaxResults() return the max of results.
float	getMinScore() Get minimum score
Pageable	getPageable() Get page settings if defined
String	getPreference() Get preference
org.elasticsearch.index.query.QueryBuilder	getQuery()
String	getRoute() Get route
List<ScriptField>	getScriptFields()
Duration	getScrollTime() For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete queries.
org.elasticsearch.action.search.SearchType	getSearchType() Type of search
Sort	getSort()
SourceFilter	getSourceFilter() Get SourceFilter to be returned to get include and exclude source fields as part of search request.
boolean	getTrackScores() Get if scores will be computed and tracked, regardless of whether sorting on a field.
Boolean	getTrackTotalHits() Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh documentation
Integer	getTrackTotalHitsUpTo() Gets the maximum value up to which total hits are tracked.
boolean	isLimiting()
void	setAggregations(List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> aggregations)
void	setCollapseBuilder(org.elasticsearch.search.collapse.CollapseBuilder collapseBuilder)
void	setHighlightQuery(HighlightQuery highlightQuery) Sets the HighlightQuery.
void	setIds(Collection<String> ids)
void	setIndicesBoost(List<IndexBoost> indicesBoost)
void	setIndicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions)
void	setMaxResults(Integer maxResults)
void	setMinScore(float minScore)
<T extends Query> T	setPageable(Pageable pageable) restrict result to entries on given page.
void	setPreference(String preference) Add preference filter to be added as part of search request
void	setRoute(String route)
void	setScriptFields(List<ScriptField> scriptFields)
void	setScrollTime(Duration scrollTime) For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete queries.
void	setSearchType(org.elasticsearch.action.search.SearchType searchType)
void	setTrackScores(boolean trackScores) Configures whether to track scores.
void	setTrackTotalHits(Boolean trackTotalHits) Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh documentation
void	setTrackTotalHitsUpTo(Integer trackTotalHitsUpTo) Sets the maximum value up to which total hits are tracked.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.elasticsearch.core.query.Query

findAll, hasScrollTime

Field Detail

pageable

protected Pageable pageable

sort

@Nullable
protected Sort sort

fields

protected List<String> fields

sourceFilter

@Nullable
protected SourceFilter sourceFilter

minScore

protected float minScore

ids

@Nullable
protected Collection<String> ids

route

@Nullable
protected String route

searchType

protected org.elasticsearch.action.search.SearchType searchType

indicesOptions

@Nullable
protected org.elasticsearch.action.support.IndicesOptions indicesOptions

trackScores

protected boolean trackScores

preference

@Nullable
protected String preference

maxResults

@Nullable
protected Integer maxResults

highlightQuery

@Nullable
protected HighlightQuery highlightQuery

Constructor Detail

NativeSearchQuery

public NativeSearchQuery(@Nullable
                         org.elasticsearch.index.query.QueryBuilder query)

NativeSearchQuery

public NativeSearchQuery(@Nullable
                         org.elasticsearch.index.query.QueryBuilder query,
                         @Nullable
                         org.elasticsearch.index.query.QueryBuilder filter)

NativeSearchQuery

public NativeSearchQuery(@Nullable
                         org.elasticsearch.index.query.QueryBuilder query,
                         @Nullable
                         org.elasticsearch.index.query.QueryBuilder filter,
                         @Nullable
                         List<org.elasticsearch.search.sort.SortBuilder<?>> sorts)

NativeSearchQuery

public NativeSearchQuery(@Nullable
                         org.elasticsearch.index.query.QueryBuilder query,
                         @Nullable
                         org.elasticsearch.index.query.QueryBuilder filter,
                         @Nullable
                         List<org.elasticsearch.search.sort.SortBuilder<?>> sorts,
                         @Nullable
                         org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields)

NativeSearchQuery

public NativeSearchQuery(@Nullable
                         org.elasticsearch.index.query.QueryBuilder query,
                         @Nullable
                         org.elasticsearch.index.query.QueryBuilder filter,
                         @Nullable
                         List<org.elasticsearch.search.sort.SortBuilder<?>> sorts,
                         @Nullable
                         org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder highlightBuilder,
                         @Nullable
                         org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields)

Method Detail

getQuery

@Nullable
public org.elasticsearch.index.query.QueryBuilder getQuery()

getFilter

@Nullable
public org.elasticsearch.index.query.QueryBuilder getFilter()

getElasticsearchSorts

@Nullable
public List<org.elasticsearch.search.sort.SortBuilder<?>> getElasticsearchSorts()

getHighlightBuilder

@Nullable
public org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder getHighlightBuilder()

getHighlightFields

@Nullable
public org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] getHighlightFields()

getScriptFields

public List<ScriptField> getScriptFields()

setScriptFields

public void setScriptFields(List<ScriptField> scriptFields)

addScriptField

public void addScriptField(ScriptField... scriptField)

getCollapseBuilder

@Nullable
public org.elasticsearch.search.collapse.CollapseBuilder getCollapseBuilder()

setCollapseBuilder

public void setCollapseBuilder(org.elasticsearch.search.collapse.CollapseBuilder collapseBuilder)

getAggregations

@Nullable
public List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> getAggregations()

addAggregation

public void addAggregation(org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?> aggregationBuilder)

setAggregations

public void setAggregations(List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> aggregations)

getIndicesBoost

@Nullable
public List<IndexBoost> getIndicesBoost()

setIndicesBoost

public void setIndicesBoost(List<IndexBoost> indicesBoost)

getSort

@Nullable
public Sort getSort()

Specified by:

getSort in interface Query

Returns:

null if not set

getPageable

public Pageable getPageable()

Description copied from interface: Query

Get page settings if defined

Specified by:

getPageable in interface Query

Returns:

setPageable

public final <T extends Query> T setPageable(Pageable pageable)

Description copied from interface: Query

restrict result to entries on given page. Corresponds to the 'start' and 'rows' parameter in elasticsearch

Specified by:

setPageable in interface Query

Returns:

addFields

public void addFields(String... fields)

Description copied from interface: Query

Add fields to be added as part of search request

Specified by:

addFields in interface Query

getFields

public List<String> getFields()

Description copied from interface: Query

Get fields to be returned as part of search request

Specified by:

getFields in interface Query

Returns:

addSourceFilter

public void addSourceFilter(SourceFilter sourceFilter)

Description copied from interface: Query

Add source filter to be added as part of search request

Specified by:

addSourceFilter in interface Query

getSourceFilter

@Nullable
public SourceFilter getSourceFilter()

Description copied from interface: Query

Get SourceFilter to be returned to get include and exclude source fields as part of search request.

Specified by:

getSourceFilter in interface Query

Returns:

SourceFilter

addSort

public final <T extends Query> T addSort(Sort sort)

Description copied from interface: Query

Add Sort to query

Specified by:

addSort in interface Query

Returns:

getMinScore

public float getMinScore()

Description copied from interface: Query

Get minimum score

Specified by:

getMinScore in interface Query

Returns:

setMinScore

public void setMinScore(float minScore)

getIds

@Nullable
public Collection<String> getIds()

Description copied from interface: Query

Get Ids

Specified by:

getIds in interface Query

Returns:

setIds

public void setIds(Collection<String> ids)

getRoute

@Nullable
public String getRoute()

Description copied from interface: Query

Get route

Specified by:

getRoute in interface Query

Returns:

setRoute

public void setRoute(String route)

setSearchType

public void setSearchType(org.elasticsearch.action.search.SearchType searchType)

getSearchType

public org.elasticsearch.action.search.SearchType getSearchType()

Description copied from interface: Query

Type of search

Specified by:

getSearchType in interface Query

Returns:

getIndicesOptions

@Nullable
public org.elasticsearch.action.support.IndicesOptions getIndicesOptions()

Description copied from interface: Query

Get indices options

Specified by:

getIndicesOptions in interface Query

Returns:

null if not set

setIndicesOptions

public void setIndicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions)

getTrackScores

public boolean getTrackScores()

Description copied from interface: Query

Get if scores will be computed and tracked, regardless of whether sorting on a field. Defaults to false.

Specified by:

getTrackScores in interface Query

Returns:

setTrackScores

public void setTrackScores(boolean trackScores)

Configures whether to track scores.

Parameters:

trackScores -

Since:

3.1

getPreference

@Nullable
public String getPreference()

Description copied from interface: Query

Get preference

Specified by:

getPreference in interface Query

Returns:

setPreference

public void setPreference(String preference)

Description copied from interface: Query

Add preference filter to be added as part of search request

Specified by:

setPreference in interface Query

isLimiting

public boolean isLimiting()

Specified by:

isLimiting in interface Query

Returns:

true if the query has a limit on the max number of results.

getMaxResults

@Nullable
public Integer getMaxResults()

Description copied from interface: Query

return the max of results. Must not return null when Query.isLimiting() returns true.

Specified by:

getMaxResults in interface Query

setMaxResults

public void setMaxResults(Integer maxResults)

setHighlightQuery

public void setHighlightQuery(HighlightQuery highlightQuery)

Description copied from interface: Query

Sets the HighlightQuery.

Specified by:

setHighlightQuery in interface Query

Parameters:

highlightQuery - the query to set

getHighlightQuery

public Optional<HighlightQuery> getHighlightQuery()

Specified by:

getHighlightQuery in interface Query

Returns:

the optional set HighlightQuery.

setTrackTotalHits

public void setTrackTotalHits(@Nullable
                              Boolean trackTotalHits)

Description copied from interface: Query

Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh documentation

Specified by:

setTrackTotalHits in interface Query

Parameters:

trackTotalHits - the value to set.

getTrackTotalHits

@Nullable
public Boolean getTrackTotalHits()

Description copied from interface: Query

Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh documentation

Specified by:

getTrackTotalHits in interface Query

Returns:

the set value.

setTrackTotalHitsUpTo

public void setTrackTotalHitsUpTo(@Nullable
                                  Integer trackTotalHitsUpTo)

Description copied from interface: Query

Sets the maximum value up to which total hits are tracked. Only relevant if #getTrackTotalHits is null

Specified by:

setTrackTotalHitsUpTo in interface Query

Parameters:

trackTotalHitsUpTo - max limit for trackTotalHits

getTrackTotalHitsUpTo

@Nullable
public Integer getTrackTotalHitsUpTo()

Description copied from interface: Query

Gets the maximum value up to which total hits are tracked. Only relevant if #getTrackTotalHits is null

Specified by:

getTrackTotalHitsUpTo in interface Query

Returns:

max limit for trackTotalHits

getScrollTime

@Nullable
public Duration getScrollTime()

Description copied from interface: Query

For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete queries. Must not return null when Query.hasScrollTime() returns true.

Specified by:

getScrollTime in interface Query

Returns:

the scrolltime settings

setScrollTime

public void setScrollTime(@Nullable
                          Duration scrollTime)

Description copied from interface: Query

For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete queries.

Specified by:

setScrollTime in interface Query

Parameters:

scrollTime - the scrolltime settings