org.springframework.data.elasticsearch.core.query

Class NativeSearchQuery

java.lang.Object

org.springframework.data.elasticsearch.core.query.BaseQuery

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

All Implemented Interfaces:

Query

public class NativeSearchQuery
extends BaseQuery

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, Sijia Liu

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.elasticsearch.core.query.Query

Query.IdWithRouting, Query.SearchType

Field Summary

Fields inherited from class org.springframework.data.elasticsearch.core.query.BaseQuery

fields, highlightQuery, ids, idsWithRouting, indicesBoost, indicesOptions, maxResults, minScore, pageable, preference, requestCache, rescorerQueries, route, runtimeFields, scrollTime, searchAfter, searchType, sort, sourceFilter, storedFields, timeout, trackScores, trackTotalHitsUpTo

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

DEFAULT_PAGE, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
NativeSearchQuery(NativeSearchQueryBuilder builder, 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)
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	addScriptField(ScriptField... scriptField)
void	addSearchExtBuilder(org.elasticsearch.search.SearchExtBuilder searchExtBuilder)
List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>>	getAggregations()
org.elasticsearch.search.collapse.CollapseBuilder	getCollapseBuilder()
List<org.elasticsearch.search.sort.SortBuilder<?>>	getElasticsearchSorts()
org.elasticsearch.index.query.QueryBuilder	getFilter()
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder	getHighlightBuilder()
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[]	getHighlightFields()
List<org.elasticsearch.search.aggregations.PipelineAggregationBuilder>	getPipelineAggregations()
org.elasticsearch.index.query.QueryBuilder	getQuery()
List<ScriptField>	getScriptFields()
List<org.elasticsearch.search.SearchExtBuilder>	getSearchExtBuilders()
org.elasticsearch.script.mustache.SearchTemplateRequestBuilder	getSearchTemplate()
org.elasticsearch.search.suggest.SuggestBuilder	getSuggestBuilder()
void	setAggregations(List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder<?>> aggregations)
void	setCollapseBuilder(org.elasticsearch.search.collapse.CollapseBuilder collapseBuilder)
void	setIndicesBoost(List<IndexBoost> indicesBoost)
void	setPipelineAggregations(List<org.elasticsearch.search.aggregations.PipelineAggregationBuilder> pipelineAggregationBuilders)
void	setScriptFields(List<ScriptField> scriptFields)
void	setSearchExtBuilders(List<org.elasticsearch.search.SearchExtBuilder> searchExtBuilders)
void	setSearchTemplate(org.elasticsearch.script.mustache.SearchTemplateRequestBuilder searchTemplate)
void	setSuggestBuilder(org.elasticsearch.search.suggest.SuggestBuilder suggestBuilder)

Methods inherited from class org.springframework.data.elasticsearch.core.query.BaseQuery

addFields, addRescorerQuery, addRuntimeField, addSort, addSourceFilter, addStoredFields, getExplain, getFields, getHighlightQuery, getIds, getIdsWithRouting, getIndicesBoost, getIndicesOptions, getMaxResults, getMinScore, getPageable, getPreference, getRequestCache, getRescorerQueries, getRoute, getRuntimeFields, getScrollTime, getSearchAfter, getSearchType, getSort, getSourceFilter, getStoredFields, getTimeout, getTrackScores, getTrackTotalHits, getTrackTotalHitsUpTo, isLimiting, setExplain, setFields, setHighlightQuery, setIds, setIdsWithRouting, setIndicesOptions, setMaxResults, setMinScore, setPageable, setPreference, setRequestCache, setRescorerQueries, setRoute, setScrollTime, setSearchAfter, setSearchType, setStoredFields, setTimeout, setTrackScores, setTrackTotalHits, setTrackTotalHitsUpTo

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, multiGetQuery, multiGetQueryWithRouting

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)

NativeSearchQuery

public NativeSearchQuery(NativeSearchQueryBuilder builder,
                         @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()

getPipelineAggregations

@Nullable
public List<org.elasticsearch.search.aggregations.PipelineAggregationBuilder> getPipelineAggregations()

addAggregation

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

setAggregations

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

setPipelineAggregations

public void setPipelineAggregations(List<org.elasticsearch.search.aggregations.PipelineAggregationBuilder> pipelineAggregationBuilders)

setIndicesBoost

public void setIndicesBoost(List<IndexBoost> indicesBoost)

getSearchTemplate

@Nullable
public org.elasticsearch.script.mustache.SearchTemplateRequestBuilder getSearchTemplate()

setSearchTemplate

public void setSearchTemplate(@Nullable
                              org.elasticsearch.script.mustache.SearchTemplateRequestBuilder searchTemplate)

setSuggestBuilder

public void setSuggestBuilder(org.elasticsearch.search.suggest.SuggestBuilder suggestBuilder)

Since:

4.3

getSuggestBuilder

@Nullable
public org.elasticsearch.search.suggest.SuggestBuilder getSuggestBuilder()

Since:

4.3

setSearchExtBuilders

public void setSearchExtBuilders(List<org.elasticsearch.search.SearchExtBuilder> searchExtBuilders)

addSearchExtBuilder

public void addSearchExtBuilder(org.elasticsearch.search.SearchExtBuilder searchExtBuilder)

getSearchExtBuilders

@Nullable
public List<org.elasticsearch.search.SearchExtBuilder> getSearchExtBuilders()