Package org.nuxeo.elasticsearch.api

Interface ElasticSearchService

All Known Implementing Classes:

ElasticSearchComponent, ElasticSearchServiceImpl

public interface ElasticSearchService

Interface to search on documents

Since:

5.9.3

Method Summary

Modifier and Type	Method	Description
void	clearScroll(EsScrollResult scrollResult)	Clear scroll on ElasticSearch cluster for the given EsScrollResult.
DocumentModelList	query(CoreSession session, String nxql, int limit, int offset, SortInfo... sortInfos)	Deprecated. since 6.0, use query with NxQueryBuilder
DocumentModelList	query(CoreSession session, org.elasticsearch.index.query.QueryBuilder queryBuilder, int limit, int offset, SortInfo... sortInfos)	Deprecated. since 6.0, use query with NxQueryBuilder
DocumentModelList	query(NxQueryBuilder queryBuilder)	Returns a document list using an NxQueryBuilder.
EsResult	queryAndAggregate(NxQueryBuilder queryBuilder)	Returns documents and aggregates.
EsScrollResult	scroll(EsScrollResult scrollResult)	Retrieves the next batch of results of a scrollable search request for the given EsScrollResult.
EsScrollResult	scroll(NxQueryBuilder queryBuilder, long keepAlive)	Performs the initial search of a scrollable search request using an NxQueryBuilder.

Method Detail

query

DocumentModelList query(NxQueryBuilder queryBuilder)

Returns a document list using an NxQueryBuilder.

Since:

5.9.5

queryAndAggregate

EsResult queryAndAggregate(NxQueryBuilder queryBuilder)

Returns documents and aggregates.

Since:

6.0

scroll

EsScrollResult scroll(NxQueryBuilder queryBuilder,
                      long keepAlive)

Performs the initial search of a scrollable search request using an NxQueryBuilder.

Parameters:

keepAlive - the search context lifetime

Returns:

an EsScrollResult including the search results and a scroll id, to be passed to the subsequent calls to scroll(EsScrollResult)

Since:

8.3

scroll

EsScrollResult scroll(EsScrollResult scrollResult)

Retrieves the next batch of results of a scrollable search request for the given EsScrollResult.

Returns:

an EsScrollResult including the search results and a scroll id, to be passed to the subsequent calls to {code scroll}.

Since:

8.3

clearScroll

void clearScroll(EsScrollResult scrollResult)

Clear scroll on ElasticSearch cluster for the given EsScrollResult.

Since:

8.4

query

@Deprecated
DocumentModelList query(CoreSession session,
                        String nxql,
                        int limit,
                        int offset,
                        SortInfo... sortInfos)

Deprecated.

since 6.0, use query with NxQueryBuilder

Returns a document list using an NXQL query. Fetch documents from the VCS repository.

Since:

5.9.3

query

@Deprecated
DocumentModelList query(CoreSession session,
                        org.elasticsearch.index.query.QueryBuilder queryBuilder,
                        int limit,
                        int offset,
                        SortInfo... sortInfos)

Deprecated.

since 6.0, use query with NxQueryBuilder

Returns a document list using an ElasticSearch QueryBuilder. Fetch documents from the VCS repository.

Since:

5.9.3