org.elasticsearch.search.builder

Class SearchSourceBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.search.builder.SearchSourceBuilder

All Implemented Interfaces:

ToXContent

public class SearchSourceBuilder
extends ToXContentToBytes

A search source builder allowing to easily build search source. Simple construction using searchSource().

See Also:

SearchRequest.source(SearchSourceBuilder)

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SearchSourceBuilder() Constructs a new search source builder.

Method Summary

Methods

Modifier and Type	Method and Description
SearchSourceBuilder	addRescorer(RescoreBuilder rescoreBuilder)
SearchSourceBuilder	aggregation(AbstractAggregationBuilder aggregation) Add an get to perform as part of the search.
SearchSourceBuilder	aggregations(byte[] aggregationsBinary) Sets a raw (xcontent / json) addAggregation.
SearchSourceBuilder	aggregations(byte[] aggregationsBinary, int aggregationsBinaryOffset, int aggregationsBinaryLength) Sets a raw (xcontent / json) addAggregation.
SearchSourceBuilder	aggregations(BytesReference aggregationsBinary) Sets a raw (xcontent / json) addAggregation.
SearchSourceBuilder	aggregations(Map aggregations) Sets a raw (xcontent / json) addAggregation.
SearchSourceBuilder	aggregations(XContentBuilder aggs) Sets a raw (xcontent / json) addAggregation.
SearchSourceBuilder	clearRescorers()
SearchSourceBuilder	defaultRescoreWindowSize(int defaultRescoreWindowSize) Deprecated. use RescoreBuilder.windowSize(int) instead.
SearchSourceBuilder	explain(Boolean explain) Should each SearchHit be returned with an explanation of the hit (ranking).
SearchSourceBuilder	fetchSource(boolean fetch) Indicates whether the response should contain the stored _source for every hit
SearchSourceBuilder	fetchSource(FetchSourceContext fetchSourceContext) Indicate how the _source should be fetched.
SearchSourceBuilder	fetchSource(String[] includes, String[] excludes) Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
SearchSourceBuilder	fetchSource(String include, String exclude) Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
SearchSourceBuilder	field(String name) Adds a field to load and return (note, it must be stored) as part of the search request.
SearchSourceBuilder	fieldDataField(String name) Adds a field to load from the field data cache and return as part of the search request.
SearchSourceBuilder	fields(List<String> fields) Sets the fields to load and return as part of the search request.
SearchSourceBuilder	fields(String... fields) Adds the fields to load and return as part of the search request.
SearchSourceBuilder	from(int from) From index to start the search from.
static HighlightBuilder	highlight() A static factory method to construct new search highlights.
SearchSourceBuilder	highlight(HighlightBuilder highlightBuilder) Adds highlight to perform as part of the search.
HighlightBuilder	highlighter()
SearchSourceBuilder	indexBoost(String index, float indexBoost) Sets the boost a specific index will receive when the query is executeed against it.
InnerHitsBuilder	innerHitsBuilder()
void	innerToXContent(XContentBuilder builder, ToXContent.Params params)
SearchSourceBuilder	minScore(float minScore) Sets the minimum score below which docs will be filtered out.
SearchSourceBuilder	noFields() Sets no fields to be loaded, resulting in only id and type to be returned per field.
SearchSourceBuilder	postFilter(byte[] postFilter) Sets a filter on the query executed that only applies to the search query (and not aggs for example).
SearchSourceBuilder	postFilter(byte[] postFilterBinary, int postFilterBinaryOffset, int postFilterBinaryLength) Sets a filter on the query executed that only applies to the search query (and not aggs for example).
SearchSourceBuilder	postFilter(BytesReference postFilterBinary) Sets a filter on the query executed that only applies to the search query (and not aggs for example).
SearchSourceBuilder	postFilter(Map postFilter) Constructs a new search source builder with a query from a map.
SearchSourceBuilder	postFilter(QueryBuilder postFilter) Sets a filter that will be executed after the query has been executed and only has affect on the search hits (not aggregations).
SearchSourceBuilder	postFilter(String postFilterString) Sets a filter on the query executed that only applies to the search query (and not aggs for example).
SearchSourceBuilder	postFilter(XContentBuilder postFilter) Constructs a new search source builder with a query from a builder.
boolean	profile() Return whether to profile query execution, or null if unspecified.
SearchSourceBuilder	profile(boolean profile) Should the query be profiled.
SearchSourceBuilder	query(byte[] queryBinary) Constructs a new search source builder with a raw search query.
SearchSourceBuilder	query(byte[] queryBinary, int queryBinaryOffset, int queryBinaryLength) Constructs a new search source builder with a raw search query.
SearchSourceBuilder	query(BytesReference queryBinary) Constructs a new search source builder with a raw search query.
SearchSourceBuilder	query(Map query) Constructs a new search source builder with a query from a map.
SearchSourceBuilder	query(QueryBuilder query) Constructs a new search source builder with a search query.
SearchSourceBuilder	query(QuerySourceBuilder querySourceBuilder) Sets the query provided as a QuerySourceBuilder
SearchSourceBuilder	query(String queryString) Constructs a new search source builder with a raw search query.
SearchSourceBuilder	query(XContentBuilder query) Constructs a new search source builder with a query from a builder.
SearchSourceBuilder	scriptField(String name, Script script) Adds a script field under the given name with the provided script.
static SearchSourceBuilder	searchSource() A static factory method to construct a new search source.
SearchSourceBuilder	size(int size) The number of search hits to return.
SearchSourceBuilder	sort(SortBuilder sort) Adds a sort builder.
SearchSourceBuilder	sort(String name) Add a sort against the given field name.
SearchSourceBuilder	sort(String name, SortOrder order) Adds a sort against the given field name and the sort ordering.
SearchSourceBuilder	stats(String... statsGroups) The stats groups this request will be aggregated under.
SuggestBuilder	suggest()
SearchSourceBuilder	terminateAfter(int terminateAfter) An optional terminate_after to terminate the search after collecting terminateAfter documents
SearchSourceBuilder	timeout(String timeout) An optional timeout to control how long search is allowed to take.
SearchSourceBuilder	timeout(TimeValue timeout) An optional timeout to control how long search is allowed to take.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
SearchSourceBuilder	trackScores(boolean trackScores) Applies when sorting, and controls if scores will be tracked as well.
SearchSourceBuilder	version(Boolean version) Should each SearchHit be returned with a version associated with it.

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchSourceBuilder

public SearchSourceBuilder()

Constructs a new search source builder.

Method Detail

searchSource

public static SearchSourceBuilder searchSource()

A static factory method to construct a new search source.

highlight

public static HighlightBuilder highlight()

A static factory method to construct new search highlights.

query

public SearchSourceBuilder query(QuerySourceBuilder querySourceBuilder)

Sets the query provided as a QuerySourceBuilder

query

public SearchSourceBuilder query(QueryBuilder query)

Constructs a new search source builder with a search query.

See Also:

QueryBuilders

query

public SearchSourceBuilder query(byte[] queryBinary)

Constructs a new search source builder with a raw search query.

query

public SearchSourceBuilder query(byte[] queryBinary,
                        int queryBinaryOffset,
                        int queryBinaryLength)

Constructs a new search source builder with a raw search query.

query

public SearchSourceBuilder query(BytesReference queryBinary)

Constructs a new search source builder with a raw search query.

query

public SearchSourceBuilder query(String queryString)

Constructs a new search source builder with a raw search query.

query

public SearchSourceBuilder query(XContentBuilder query)

Constructs a new search source builder with a query from a builder.

query

public SearchSourceBuilder query(Map query)

Constructs a new search source builder with a query from a map.

postFilter

public SearchSourceBuilder postFilter(QueryBuilder postFilter)

Sets a filter that will be executed after the query has been executed and only has affect on the search hits (not aggregations). This filter is always executed as last filtering mechanism.

postFilter

public SearchSourceBuilder postFilter(String postFilterString)

Sets a filter on the query executed that only applies to the search query (and not aggs for example).

postFilter

public SearchSourceBuilder postFilter(byte[] postFilter)

Sets a filter on the query executed that only applies to the search query (and not aggs for example).

postFilter

public SearchSourceBuilder postFilter(byte[] postFilterBinary,
                             int postFilterBinaryOffset,
                             int postFilterBinaryLength)

Sets a filter on the query executed that only applies to the search query (and not aggs for example).

postFilter

public SearchSourceBuilder postFilter(BytesReference postFilterBinary)

Sets a filter on the query executed that only applies to the search query (and not aggs for example).

postFilter

public SearchSourceBuilder postFilter(XContentBuilder postFilter)

Constructs a new search source builder with a query from a builder.

postFilter

public SearchSourceBuilder postFilter(Map postFilter)

Constructs a new search source builder with a query from a map.

from

public SearchSourceBuilder from(int from)

From index to start the search from. Defaults to 0.

size

public SearchSourceBuilder size(int size)

The number of search hits to return. Defaults to 10.

minScore

public SearchSourceBuilder minScore(float minScore)

Sets the minimum score below which docs will be filtered out.

explain

public SearchSourceBuilder explain(Boolean explain)

Should each SearchHit be returned with an explanation of the hit (ranking).

version

public SearchSourceBuilder version(Boolean version)

Should each SearchHit be returned with a version associated with it.

timeout

public SearchSourceBuilder timeout(TimeValue timeout)

An optional timeout to control how long search is allowed to take.

timeout

public SearchSourceBuilder timeout(String timeout)

An optional timeout to control how long search is allowed to take.

terminateAfter

public SearchSourceBuilder terminateAfter(int terminateAfter)

An optional terminate_after to terminate the search after collecting terminateAfter documents

sort

public SearchSourceBuilder sort(String name,
                       SortOrder order)

Adds a sort against the given field name and the sort ordering.

Parameters:

name - The name of the field

order - The sort ordering

sort

public SearchSourceBuilder sort(String name)

Add a sort against the given field name.

Parameters:

name - The name of the field to sort by

sort

public SearchSourceBuilder sort(SortBuilder sort)

Adds a sort builder.

trackScores

public SearchSourceBuilder trackScores(boolean trackScores)

Applies when sorting, and controls if scores will be tracked as well. Defaults to false.

aggregation

public SearchSourceBuilder aggregation(AbstractAggregationBuilder aggregation)

Add an get to perform as part of the search.

aggregations

public SearchSourceBuilder aggregations(byte[] aggregationsBinary)

Sets a raw (xcontent / json) addAggregation.

aggregations

public SearchSourceBuilder aggregations(byte[] aggregationsBinary,
                               int aggregationsBinaryOffset,
                               int aggregationsBinaryLength)

Sets a raw (xcontent / json) addAggregation.

aggregations

public SearchSourceBuilder aggregations(BytesReference aggregationsBinary)

Sets a raw (xcontent / json) addAggregation.

aggregations

public SearchSourceBuilder aggregations(XContentBuilder aggs)

Sets a raw (xcontent / json) addAggregation.

defaultRescoreWindowSize

@Deprecated
public SearchSourceBuilder defaultRescoreWindowSize(int defaultRescoreWindowSize)

Deprecated. use RescoreBuilder.windowSize(int) instead.

Set the rescore window size for rescores that don't specify their window.

aggregations

public SearchSourceBuilder aggregations(Map aggregations)

Sets a raw (xcontent / json) addAggregation.

highlighter

public HighlightBuilder highlighter()

highlight

public SearchSourceBuilder highlight(HighlightBuilder highlightBuilder)

Adds highlight to perform as part of the search.

innerHitsBuilder

public InnerHitsBuilder innerHitsBuilder()

suggest

public SuggestBuilder suggest()

addRescorer

public SearchSourceBuilder addRescorer(RescoreBuilder rescoreBuilder)

clearRescorers

public SearchSourceBuilder clearRescorers()

profile

public SearchSourceBuilder profile(boolean profile)

Should the query be profiled. Defaults to false

profile

public boolean profile()

Return whether to profile query execution, or null if unspecified.

fetchSource

public SearchSourceBuilder fetchSource(boolean fetch)

Indicates whether the response should contain the stored _source for every hit

fetchSource

public SearchSourceBuilder fetchSource(@Nullable
                              String include,
                              @Nullable
                              String exclude)

Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

include - An optional include (optionally wildcarded) pattern to filter the returned _source

exclude - An optional exclude (optionally wildcarded) pattern to filter the returned _source

fetchSource

public SearchSourceBuilder fetchSource(@Nullable
                              String[] includes,
                              @Nullable
                              String[] excludes)

Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.

Parameters:

includes - An optional list of include (optionally wildcarded) pattern to filter the returned _source

excludes - An optional list of exclude (optionally wildcarded) pattern to filter the returned _source

fetchSource

public SearchSourceBuilder fetchSource(@Nullable
                              FetchSourceContext fetchSourceContext)

Indicate how the _source should be fetched.

noFields

public SearchSourceBuilder noFields()

Sets no fields to be loaded, resulting in only id and type to be returned per field.

fields

public SearchSourceBuilder fields(List<String> fields)

Sets the fields to load and return as part of the search request. If none are specified, the source of the document will be returned.

fields

public SearchSourceBuilder fields(String... fields)

Adds the fields to load and return as part of the search request. If none are specified, the source of the document will be returned.

field

public SearchSourceBuilder field(String name)

Adds a field to load and return (note, it must be stored) as part of the search request. If none are specified, the source of the document will be return.

fieldDataField

public SearchSourceBuilder fieldDataField(String name)

Adds a field to load from the field data cache and return as part of the search request.

scriptField

public SearchSourceBuilder scriptField(String name,
                              Script script)

Adds a script field under the given name with the provided script.

Parameters:

name - The name of the field

script - The script

indexBoost

public SearchSourceBuilder indexBoost(String index,
                             float indexBoost)

Sets the boost a specific index will receive when the query is executeed against it.

Parameters:

index - The index to apply the boost against

indexBoost - The boost to apply to the index

stats

public SearchSourceBuilder stats(String... statsGroups)

The stats groups this request will be aggregated under.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Throws:

IOException

innerToXContent

public void innerToXContent(XContentBuilder builder,
                   ToXContent.Params params)
                     throws IOException

Throws:

IOException