org.springframework.data.elasticsearch.core

Interface SearchOperations

All Known Subinterfaces:

ElasticsearchOperations

All Known Implementing Classes:

AbstractElasticsearchTemplate, ElasticsearchRestTemplate, ElasticsearchTemplate

public interface SearchOperations

The operations for the Elasticsearch Document APIs.

Since:

4.0

Author:

Peter-Josef Meisch, Sascha Woo

Method Summary

Modifier and Type	Method and Description
long	count(Query query, Class<?> clazz) return number of elements found by given query
long	count(Query query, Class<?> clazz, IndexCoordinates index) return number of elements found by given query
default long	count(Query query, IndexCoordinates index) Return number of elements found by given query.
default <T> AggregatedPage<T>	moreLikeThis(MoreLikeThisQuery query, Class<T> clazz, IndexCoordinates index) Deprecated. since 4.0, use search(MoreLikeThisQuery, Class, IndexCoordinates).
<T> List<SearchHits<T>>	multiSearch(List<? extends Query> queries, Class<T> clazz) Execute the multi search query against elasticsearch and return result as List of SearchHits.
<T> List<SearchHits<T>>	multiSearch(List<? extends Query> queries, Class<T> clazz, IndexCoordinates index) Execute the multi search query against elasticsearch and return result as List of SearchHits.
List<SearchHits<?>>	multiSearch(List<? extends Query> queries, List<Class<?>> classes) Execute the multi search query against elasticsearch and return result as List of SearchHits.
List<SearchHits<?>>	multiSearch(List<? extends Query> queries, List<Class<?>> classes, IndexCoordinates index) Execute the multi search query against elasticsearch and return result as List of SearchHits.
default List<String>	queryForIds(Query query, Class<?> clazz, IndexCoordinates index) Deprecated. since 4.0 use search(Query, Class, IndexCoordinates) and map the results.
default <T> List<List<T>>	queryForList(List<Query> queries, Class<T> clazz, IndexCoordinates index) Deprecated. since 4.0, use multiSearch(List, Class, IndexCoordinates).
default List<List<?>>	queryForList(List<Query> queries, List<Class<?>> classes, IndexCoordinates index) Deprecated. since 4.0, use multiSearch(List, List, IndexCoordinates).
default <T> List<T>	queryForList(Query query, Class<T> clazz, IndexCoordinates index) Deprecated. since 4.0, use search(Query, Class, IndexCoordinates).
default <T> T	queryForObject(Query query, Class<T> clazz, IndexCoordinates index) Deprecated. since 4.0, use searchOne(Query, Class, IndexCoordinates).
default <T> List<Page<T>>	queryForPage(List<? extends Query> queries, Class<T> clazz, IndexCoordinates index) Deprecated. since 4.0, use multiSearch(List, Class, IndexCoordinates).
default List<AggregatedPage<?>>	queryForPage(List<? extends Query> queries, List<Class<?>> classes, IndexCoordinates index) Deprecated. since 4.0, use multiSearch(List, List, IndexCoordinates).
default <T> AggregatedPage<T>	queryForPage(Query query, Class<T> clazz, IndexCoordinates index) Deprecated. since 4.0, use search(Query, Class, IndexCoordinates).
<T> SearchHits<T>	search(MoreLikeThisQuery query, Class<T> clazz) more like this query to search for documents that are "like" a specific document.
<T> SearchHits<T>	search(MoreLikeThisQuery query, Class<T> clazz, IndexCoordinates index) more like this query to search for documents that are "like" a specific document.
<T> SearchHits<T>	search(Query query, Class<T> clazz) Execute the criteria query against elasticsearch and return result as SearchHits
<T> SearchHits<T>	search(Query query, Class<T> clazz, IndexCoordinates index) Execute the criteria query against elasticsearch and return result as SearchHits
<T> SearchHitsIterator<T>	searchForStream(Query query, Class<T> clazz) Executes the given Query against elasticsearch and return result as SearchHitsIterator.
<T> SearchHitsIterator<T>	searchForStream(Query query, Class<T> clazz, IndexCoordinates index) Executes the given Query against elasticsearch and return result as SearchHitsIterator.
default <T> SearchHit<T>	searchOne(Query query, Class<T> clazz) Execute the query against elasticsearch and return the first returned object.
default <T> SearchHit<T>	searchOne(Query query, Class<T> clazz, IndexCoordinates index) Execute the query against elasticsearch and return the first returned object.
<T> CloseableIterator<T>	stream(Query query, Class<T> clazz, IndexCoordinates index) Deprecated. since 4.0, use searchForStream(Query, Class, IndexCoordinates).
org.elasticsearch.action.search.SearchResponse	suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, Class<?> clazz) Does a suggest query
org.elasticsearch.action.search.SearchResponse	suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, IndexCoordinates index) Does a suggest query

Method Detail

count

default long count(Query query,
                   IndexCoordinates index)

Return number of elements found by given query.

Parameters:

query - the query to execute

index - the index to run the query against

Returns:

count

count

long count(Query query,
           Class<?> clazz)

return number of elements found by given query

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping and index name extraction

Returns:

count

count

long count(Query query,
           @Nullable
           Class<?> clazz,
           IndexCoordinates index)

return number of elements found by given query

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

count

queryForObject

@Deprecated
default <T> T queryForObject(Query query,
                                         Class<T> clazz,
                                         IndexCoordinates index)

Deprecated. since 4.0, use searchOne(Query, Class, IndexCoordinates).

Execute the query against elasticsearch and return the first returned object.

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

the first matching object

queryForPage

@Deprecated
default <T> AggregatedPage<T> queryForPage(Query query,
                                                       Class<T> clazz,
                                                       IndexCoordinates index)

Deprecated. since 4.0, use search(Query, Class, IndexCoordinates).

Execute the query against elasticsearch and return result as Page.

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

a page with aggregations

queryForPage

@Deprecated
default <T> List<Page<T>> queryForPage(List<? extends Query> queries,
                                                   Class<T> clazz,
                                                   IndexCoordinates index)

Deprecated. since 4.0, use multiSearch(List, Class, IndexCoordinates).

Execute the multi-search against elasticsearch and return result as List of Page

Parameters:

queries - the queries

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

list of pages with the results

queryForPage

@Deprecated
default List<AggregatedPage<?>> queryForPage(List<? extends Query> queries,
                                                         List<Class<?>> classes,
                                                         IndexCoordinates index)

Deprecated. since 4.0, use multiSearch(List, List, IndexCoordinates).

Execute the multi-search against elasticsearch and return result as List of Page

Parameters:

queries - the queries

classes - the entity classes used for the queries

index - the index to run the query against

Returns:

list of pages with the results

stream

@Deprecated
<T> CloseableIterator<T> stream(Query query,
                                            Class<T> clazz,
                                            IndexCoordinates index)

Deprecated. since 4.0, use searchForStream(Query, Class, IndexCoordinates).

Executes the given Query against elasticsearch and return result as CloseableIterator.

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

a CloseableIterator that wraps an Elasticsearch scroll context that needs to be closed. The try-with-resources construct should be used to ensure that the close method is invoked after the operations are completed.

queryForList

@Deprecated
default <T> List<T> queryForList(Query query,
                                             Class<T> clazz,
                                             IndexCoordinates index)

Deprecated. since 4.0, use search(Query, Class, IndexCoordinates).

Execute the criteria query against elasticsearch and return result as List

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

list of found objects

queryForList

@Deprecated
default <T> List<List<T>> queryForList(List<Query> queries,
                                                   Class<T> clazz,
                                                   IndexCoordinates index)

Deprecated. since 4.0, use multiSearch(List, Class, IndexCoordinates).

Execute the multi search query against elasticsearch and return result as List

Type Parameters:

T - element return type

Parameters:

queries - the queries to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

list of found objects

queryForList

@Deprecated
default List<List<?>> queryForList(List<Query> queries,
                                               List<Class<?>> classes,
                                               IndexCoordinates index)

Deprecated. since 4.0, use multiSearch(List, List, IndexCoordinates).

Execute the multi search query against elasticsearch and return result as List

Parameters:

queries - the queries to execute

classes - the entity classes used for property mapping

index - the index to run the query against

Returns:

list of list of found objects

queryForIds

@Deprecated
default List<String> queryForIds(Query query,
                                             Class<?> clazz,
                                             IndexCoordinates index)

Deprecated. since 4.0 use search(Query, Class, IndexCoordinates) and map the results.

Execute the query against elasticsearch and return ids

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

list of found object ids

moreLikeThis

@Deprecated
default <T> AggregatedPage<T> moreLikeThis(MoreLikeThisQuery query,
                                                       Class<T> clazz,
                                                       IndexCoordinates index)

Deprecated. since 4.0, use search(MoreLikeThisQuery, Class, IndexCoordinates).

more like this query to search for documents that are "like" a specific document.

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

page with the results

suggest

org.elasticsearch.action.search.SearchResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                       Class<?> clazz)

Does a suggest query

Parameters:

suggestion - the query

the - entity class

Returns:

the suggest response

Since:

4.1

suggest

org.elasticsearch.action.search.SearchResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                       IndexCoordinates index)

Does a suggest query

Parameters:

suggestion - the query

index - the index to run the query against

Returns:

the suggest response

searchOne

@Nullable
default <T> SearchHit<T> searchOne(Query query,
                                             Class<T> clazz)

Execute the query against elasticsearch and return the first returned object.

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping and indexname extraction

Returns:

the first found object

searchOne

@Nullable
default <T> SearchHit<T> searchOne(Query query,
                                             Class<T> clazz,
                                             IndexCoordinates index)

Execute the query against elasticsearch and return the first returned object.

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

the first found object

multiSearch

<T> List<SearchHits<T>> multiSearch(List<? extends Query> queries,
                                    Class<T> clazz)

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Type Parameters:

T - element return type

Parameters:

queries - the queries to execute

clazz - the entity clazz

Returns:

list of SearchHits

Since:

4.1

multiSearch

<T> List<SearchHits<T>> multiSearch(List<? extends Query> queries,
                                    Class<T> clazz,
                                    IndexCoordinates index)

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Type Parameters:

T - element return type

Parameters:

queries - the queries to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

list of SearchHits

multiSearch

List<SearchHits<?>> multiSearch(List<? extends Query> queries,
                                List<Class<?>> classes)

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Parameters:

queries - the queries to execute

classes - the entity classes

Returns:

list of SearchHits

Since:

4.1

multiSearch

List<SearchHits<?>> multiSearch(List<? extends Query> queries,
                                List<Class<?>> classes,
                                IndexCoordinates index)

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Parameters:

queries - the queries to execute

classes - the entity classes used for property mapping

index - the index to run the query against

Returns:

list of SearchHits

search

<T> SearchHits<T> search(Query query,
                         Class<T> clazz)

Execute the criteria query against elasticsearch and return result as SearchHits

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping and index name extraction

Returns:

SearchHits containing the list of found objects

search

<T> SearchHits<T> search(Query query,
                         Class<T> clazz,
                         IndexCoordinates index)

Execute the criteria query against elasticsearch and return result as SearchHits

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

SearchHits containing the list of found objects

search

<T> SearchHits<T> search(MoreLikeThisQuery query,
                         Class<T> clazz)

more like this query to search for documents that are "like" a specific document.

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping and index name extraction

Returns:

SearchHits containing the list of found objects

search

<T> SearchHits<T> search(MoreLikeThisQuery query,
                         Class<T> clazz,
                         IndexCoordinates index)

more like this query to search for documents that are "like" a specific document.

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

SearchHits containing the list of found objects

searchForStream

<T> SearchHitsIterator<T> searchForStream(Query query,
                                          Class<T> clazz)

Executes the given Query against elasticsearch and return result as SearchHitsIterator.

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping and index name extraction

Returns:

a SearchHitsIterator that wraps an Elasticsearch scroll context that needs to be closed. The try-with-resources construct should be used to ensure that the close method is invoked after the operations are completed.

searchForStream

<T> SearchHitsIterator<T> searchForStream(Query query,
                                          Class<T> clazz,
                                          IndexCoordinates index)

Executes the given Query against elasticsearch and return result as SearchHitsIterator.

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

a SearchHitsIterator that wraps an Elasticsearch scroll context that needs to be closed. The try-with-resources construct should be used to ensure that the close method is invoked after the operations are completed.