org.springframework.data.elasticsearch.core.query

Interface Query

All Known Subinterfaces:

SearchQuery

All Known Implementing Classes:

CriteriaQuery, NativeSearchQuery, StringQuery

public interface Query

Query

Author:

Rizwan Idrees, Mohsin Husen, Mark Paluch, Alen Turkovic, Sascha Woo, Christoph Strobl, Farid Azaza

Field Summary

Fields

Modifier and Type	Field and Description
static Pageable	DEFAULT_PAGE
static int	DEFAULT_PAGE_SIZE

Method Summary

Modifier and Type	Method and Description
void	addFields(String... fields) Add fields to be added as part of search request
void	addIndices(String... indices) Add Indices to be added as part of search request
<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
void	addTypes(String... types) Add types to be searched
static Query	findAll() Get get a Query that matches all documents in the index.
List<String>	getFields() Get fields to be returned as part of search request
Collection<String>	getIds() Get Ids
List<String>	getIndices() Get Indices to be searched
org.elasticsearch.action.support.IndicesOptions	getIndicesOptions() Get indices options
float	getMinScore() Get minimum score
Pageable	getPageable() Get page settings if defined
String	getPreference() Get preference
String	getRoute() Get route
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.
List<String>	getTypes() Get types to be searched
<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

Field Detail

DEFAULT_PAGE_SIZE

static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

DEFAULT_PAGE

static final Pageable DEFAULT_PAGE

Method Detail

findAll

static Query findAll()

Get get a Query that matches all documents in the index.

Returns:

new instance of Query.

Since:

3.2

See Also:

QueryBuilders.matchAllQuery()

setPageable

<T extends Query> T setPageable(Pageable pageable)

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

Parameters:

pageable -

Returns:

getPageable

Pageable getPageable()

Get page settings if defined

Returns:

addSort

<T extends Query> T addSort(Sort sort)

Add Sort to query

Parameters:

sort -

Returns:

getSort

Sort getSort()

Returns:

null if not set

getIndices

List<String> getIndices()

Get Indices to be searched

Returns:

addIndices

void addIndices(String... indices)

Add Indices to be added as part of search request

Parameters:

indices -

addTypes

void addTypes(String... types)

Add types to be searched

Parameters:

types -

getTypes

List<String> getTypes()

Get types to be searched

Returns:

addFields

void addFields(String... fields)

Add fields to be added as part of search request

Parameters:

fields -

getFields

List<String> getFields()

Get fields to be returned as part of search request

Returns:

addSourceFilter

void addSourceFilter(SourceFilter sourceFilter)

Add source filter to be added as part of search request

Parameters:

sourceFilter -

getSourceFilter

SourceFilter getSourceFilter()

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

Returns:

SourceFilter

getMinScore

float getMinScore()

Get minimum score

Returns:

getTrackScores

boolean getTrackScores()

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

Returns:

Since:

3.1

getIds

Collection<String> getIds()

Get Ids

Returns:

getRoute

String getRoute()

Get route

Returns:

getSearchType

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

Type of search

Returns:

getIndicesOptions

org.elasticsearch.action.support.IndicesOptions getIndicesOptions()

Get indices options

Returns:

null if not set

getPreference

String getPreference()

Get preference

Returns:

Since:

3.2

setPreference

void setPreference(String preference)

Add preference filter to be added as part of search request

Parameters:

preference -

Since:

3.2