SearchQuery (Nuxeo 2025.0.157 API Documentation)

All Known Implementing Classes:: SearchQueryImpl

public interface SearchQuery

Since:: 2025.0

Method Summary

Modifier and Type

Method

Description

static SearchQueryImpl.Builder

builder(List<SearchIndex> searchIndexes, String nxql, NuxeoPrincipal principal)

static SearchQueryImpl.Builder

builder(CoreSession session, String nxql)

static SearchQueryImpl.Builder

builder(SearchIndex searchIndex, String nxql)

static SearchQueryImpl.Builder

builder(SearchIndex searchIndex, String nxql, NuxeoPrincipal principal)

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(CoreSession session, String nxql)
- builder
  
  static SearchQueryImpl.Builder builder(SearchIndex searchIndex, String nxql)
- builder
  
  static SearchQueryImpl.Builder builder(SearchIndex searchIndex, String nxql, NuxeoPrincipal principal)
- builder
  
  static SearchQueryImpl.Builder builder(List<SearchIndex> searchIndexes, String nxql, NuxeoPrincipal principal)