Package org.nuxeo.ecm.core.search

Interface SearchQuery

All Known Implementing Classes:

SearchQueryImpl

public interface SearchQuery

Since:

2025.0

Method Summary

Modifier and Type	Method	Description
static SearchQueryImpl.Builder	builder(String nxql)	Returns a query builder initialized with an NXQL query, the current principal and the default search index of the default repository.
static SearchQueryImpl.Builder	builder(String nxql, CoreSession session)	Returns a query builder initialized with an NXQL query, principal and repository taken from the session, the search index is the default one for the session's repository.
static SearchQueryImpl.Builder	builder(String nxql, NuxeoPrincipal principal)	Returns a query builder initialized with an NXQL query on a given principal.
static SearchQueryImpl.Builder	builder(List<SearchIndex> searchIndexes, String nxql, NuxeoPrincipal principal)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.1, use builder(String, NuxeoPrincipal) instead.
static SearchQueryImpl.Builder	builder(CoreSession session, String nxql)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.1, use builder(String, CoreSession) instead.
static SearchQueryImpl.Builder	builder(SearchIndex searchIndex, String nxql)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.1, use builder(String) instead.
static SearchQueryImpl.Builder	builder(SearchIndex searchIndex, String nxql, NuxeoPrincipal principal)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.1, use builder(String, NuxeoPrincipal) instead.
List<Aggregate<? extends Bucket>>	getAggregates()
List<String>	getHighlights()
int	getLimit()
int	getOffset()
NuxeoPrincipal	getPrincipal()
SQLQuery	getQuery()
Duration	getScrollKeepAlive()
int	getScrollSize()
List<SearchIndex>	getSearchIndexes()	Gets the list of searchIndex to perform the query.
Map<String,Type>	getSelectFields()	Returns the fields present in the SELECT clause with their type if it exists
default boolean	isMultiRepositories()
boolean	isScrollSearch()

Method Details

getSearchIndexes

List<SearchIndex> getSearchIndexes()

Gets the list of searchIndex to perform the query. If there are more than one item it's a multi repository search, note that all search indexes share the same search client.

isMultiRepositories

default boolean isMultiRepositories()

getQuery

SQLQuery getQuery()

getPrincipal

NuxeoPrincipal getPrincipal()

getOffset

int getOffset()

getLimit

int getLimit()

isScrollSearch

boolean isScrollSearch()

getScrollKeepAlive

Duration getScrollKeepAlive()

getScrollSize

int getScrollSize()

getHighlights

List<String> getHighlights()

getAggregates

List<Aggregate<? extends Bucket>> getAggregates()

getSelectFields

Map<String,Type> getSelectFields()

Returns the fields present in the SELECT clause with their type if it exists

builder

static SearchQueryImpl.Builder builder(String nxql)

Returns a query builder initialized with an NXQL query, the current principal and the default search index of the default repository.

Since:

2025.1

builder

static SearchQueryImpl.Builder builder(String nxql,
 CoreSession session)

Returns a query builder initialized with an NXQL query, principal and repository taken from the session, the search index is the default one for the session's repository.

Since:

2025.1

builder

static SearchQueryImpl.Builder builder(String nxql,
 NuxeoPrincipal principal)

Returns a query builder initialized with an NXQL query on a given principal.

Since:

2025.1

builder

@Deprecated(since="2025.1",
            forRemoval=true)
static SearchQueryImpl.Builder builder(CoreSession session,
 String nxql)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.1, use builder(String, CoreSession) instead.

builder

@Deprecated(since="2025.1",
            forRemoval=true)
static SearchQueryImpl.Builder builder(SearchIndex searchIndex,
 String nxql)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.1, use builder(String) instead.

builder

@Deprecated(since="2025.1",
            forRemoval=true)
static SearchQueryImpl.Builder builder(SearchIndex searchIndex,
 String nxql,
 NuxeoPrincipal principal)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.1, use builder(String, NuxeoPrincipal) instead.

builder

@Deprecated(since="2025.1",
            forRemoval=true)
static SearchQueryImpl.Builder builder(List<SearchIndex> searchIndexes,
 String nxql,
 NuxeoPrincipal principal)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.1, use builder(String, NuxeoPrincipal) instead.