All Superinterfaces:

Stage.AbstractQuery

All Known Subinterfaces:

Stage.Query<R>

Enclosing interface:

Stage
```
public static interface Stage.SelectionQuery<R>
extends Stage.AbstractQuery
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`Stage.SelectionQuery<R>`	`enableFetchProfile(String profileName)`	Enable a fetch profile which will be in effect during execution of this query.
`CacheMode`	`getCacheMode()`	Obtain the `CacheMode` in effect for this query.
`String`	`getCacheRegion()`
`CacheRetrieveMode`	`getCacheRetrieveMode()`
`CacheStoreMode`	`getCacheStoreMode()`
`int`	`getFirstResult()`
`FlushMode`	`getFlushMode()`	Obtain the `FlushMode` in effect for this query.
`int`	`getMaxResults()`
`CompletionStage<Long>`	`getResultCount()`	Determine the size of the query result list that would be returned by calling `getResultList()` with no offset or limit applied to the query.
`CompletionStage<List<R>>`	`getResultList()`	Asynchronously execute this query, returning the query results as a `List`, via a `CompletionStage`.
`CompletionStage<R>`	`getSingleResult()`	Asynchronously execute this query, returning a single row that matches the query, throwing an exception if the query returns zero rows or more than one matching row.
`CompletionStage<R>`	`getSingleResultOrNull()`	Asynchronously execute this query, returning a single row that matches the query, or `null` if the query returns no results, throwing an exception if the query returns more than one matching row.
`boolean`	`isCacheable()`
`boolean`	`isReadOnly()`
`Stage.SelectionQuery<R>`	`setCacheable(boolean cacheable)`	Enable or disable caching of this query result set in the second-level query cache.
`Stage.SelectionQuery<R>`	`setCacheMode(CacheMode cacheMode)`	Set the current `CacheMode` in effect while this query is being executed.
`Stage.SelectionQuery<R>`	`setCacheRegion(String cacheRegion)`	Set the name of the cache region in which to store this query result set if `caching is enabled`.
`default Stage.SelectionQuery<R>`	`setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)`	Set the current `CacheRetrieveMode` in effect while this query is being executed.
`default Stage.SelectionQuery<R>`	`setCacheStoreMode(CacheStoreMode cacheStoreMode)`	Set the current `CacheStoreMode` in effect while this query is being executed.
`Stage.SelectionQuery<R>`	`setComment(String comment)`	Set the comment for this query.
`Stage.SelectionQuery<R>`	`setFirstResult(int firstResult)`	Set the position of the first result that may be returned by this query when executed, where the results are numbered from 0.
`default Stage.SelectionQuery<R>`	`setFlushMode(FlushModeType flushModeType)`	Set the current `FlushModeType` in effect while this query is being executed.
`Stage.SelectionQuery<R>`	`setFlushMode(FlushMode flushMode)`	Set the current `FlushMode` in effect while this query is being executed.
`default Stage.SelectionQuery<R>`	`setLockMode(LockModeType lockModeType)`	Set the `LockModeType` to use for the whole query.
`default Stage.SelectionQuery<R>`	`setLockMode(String alias, LockModeType lockModeType)`	Set the `LockModeType` to use for specified alias (as defined in the query's `from` clause).
`Stage.SelectionQuery<R>`	`setLockMode(String alias, LockMode lockMode)`	Set the `LockMode` to use for specified alias (as defined in the query's `from` clause).
`Stage.SelectionQuery<R>`	`setLockMode(LockMode lockMode)`	Set the `LockMode` to use for the whole query.
`Stage.SelectionQuery<R>`	`setMaxResults(int maxResults)`	Set the maximum number of results that may be returned by this query when executed.
`Stage.SelectionQuery<R>`	`setOrder(List<Order<? super R>> orderList)`	If the result type of this query is an entity class, add one or more rules for ordering the query results.
`Stage.SelectionQuery<R>`	`setOrder(Order<? super R> order)`	If the result type of this query is an entity class, add a rule for ordering the query results.
`Stage.SelectionQuery<R>`	`setPage(Page page)`	Set the page of results to return.
`Stage.SelectionQuery<R>`	`setParameter(int parameter, Object argument)`	Set the value of an ordinal parameter.
`<T> Stage.SelectionQuery<R>`	`setParameter(Parameter<T> parameter, T argument)`	Set the value of a typed parameter.
`Stage.SelectionQuery<R>`	`setParameter(String parameter, Object argument)`	Set the value of a named parameter.
`Stage.SelectionQuery<R>`	`setPlan(EntityGraph<R> entityGraph)`	Set the `EntityGraph` that will be used as a fetch plan for the root entity returned by this query.
`Stage.SelectionQuery<R>`	`setReadOnly(boolean readOnly)`	Set the read-only/modifiable mode for entities and proxies loaded by this Query.

Methods inherited from interface org.hibernate.reactive.stage.Stage.AbstractQuery
getComment

- Method Detail
  - setMaxResults
```
Stage.SelectionQuery<R> setMaxResults(int maxResults)
```
    Set the maximum number of results that may be returned by this query when executed.
  - setFirstResult
```
Stage.SelectionQuery<R> setFirstResult(int firstResult)
```
    Set the position of the first result that may be returned by this query when executed, where the results are numbered from 0.
  - setPage
```
@Incubating
Stage.SelectionQuery<R> setPage(Page page)
```
    Set the page of results to return.
    
    Since:
    
    2.1
    
    See Also:
    
    Page
  - getMaxResults
```
int getMaxResults()
```
    Returns:
    
    the maximum number results, or Integer.MAX_VALUE if not set
  - getFirstResult
```
int getFirstResult()
```
    Returns:
    
    the first result, or 0 if not set
  - getSingleResult
```
CompletionStage<R> getSingleResult()
```
    Asynchronously execute this query, returning a single row that matches the query, throwing an exception if the query returns zero rows or more than one matching row. If the query has multiple results per row, the results are returned in an instance of Object[].
    
    Returns:
    
    the single resulting row
    
    Throws:
    
    NoResultException - if there is no result
    
    NonUniqueResultException - if there are multiple results
    
    See Also:
    
    Query.getSingleResult()
  - getSingleResultOrNull
```
CompletionStage<R> getSingleResultOrNull()
```
    Asynchronously execute this query, returning a single row that matches the query, or null if the query returns no results, throwing an exception if the query returns more than one matching row. If the query has multiple results per row, the results are returned in an instance of Object[].
    
    Returns:
    
    the single resulting row or null
    
    Throws:
    
    NonUniqueResultException - if there are multiple results
    
    See Also:
    
    getSingleResult()
  - getResultCount
```
@Incubating
CompletionStage<Long> getResultCount()
```
    Determine the size of the query result list that would be returned by calling getResultList() with no offset or limit applied to the query.
    
    Returns:
    
    the size of the list that would be returned
  - getResultList
```
CompletionStage<List<R>> getResultList()
```
    Asynchronously execute this query, returning the query results as a List, via a CompletionStage. If the query has multiple results per row, the results are returned in an instance of Object[].
    
    Returns:
    
    the resulting rows as a List
    
    See Also:
    
    Query.getResultList()
  - setReadOnly
```
Stage.SelectionQuery<R> setReadOnly(boolean readOnly)
```
    Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context.
    
    See Also:
    
    Stage.Session.setDefaultReadOnly(boolean)
  - isReadOnly
```
boolean isReadOnly()
```
    Returns:
    
    the read-only/modifiable mode
    
    See Also:
    
    Stage.Session.isDefaultReadOnly()
  - setCacheable
```
Stage.SelectionQuery<R> setCacheable(boolean cacheable)
```
    Enable or disable caching of this query result set in the second-level query cache.
    
    Parameters:
    
    cacheable - true if this query is cacheable
  - isCacheable
```
boolean isCacheable()
```
    Returns:
    
    true if this query is cacheable
    
    See Also:
    
    setCacheable(boolean)
  - setCacheRegion
```
Stage.SelectionQuery<R> setCacheRegion(String cacheRegion)
```
    Set the name of the cache region in which to store this query result set if caching is enabled.
    
    Parameters:
    
    cacheRegion - the name of the cache region
  - getCacheRegion
```
String getCacheRegion()
```
    Returns:
    
    the name of the cache region
    
    See Also:
    
    setCacheRegion(String)
  - setCacheMode
```
Stage.SelectionQuery<R> setCacheMode(CacheMode cacheMode)
```
    Set the current CacheMode in effect while this query is being executed.
  - setCacheStoreMode
```
default Stage.SelectionQuery<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)
```
    Set the current CacheStoreMode in effect while this query is being executed.
  - setCacheRetrieveMode
```
default Stage.SelectionQuery<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
```
    Set the current CacheRetrieveMode in effect while this query is being executed.
  - getCacheStoreMode
```
CacheStoreMode getCacheStoreMode()
```
  - getCacheRetrieveMode
```
CacheRetrieveMode getCacheRetrieveMode()
```
  - getCacheMode
```
CacheMode getCacheMode()
```
    Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the Stage.Session from which is originates.
    
    See Also:
    
    Stage.Session.getCacheMode()
  - setFlushMode
```
Stage.SelectionQuery<R> setFlushMode(FlushMode flushMode)
```
    Set the current FlushMode in effect while this query is being executed.
  - setFlushMode
```
default Stage.SelectionQuery<R> setFlushMode(FlushModeType flushModeType)
```
    Set the current FlushModeType in effect while this query is being executed.
  - getFlushMode
```
FlushMode getFlushMode()
```
    Obtain the FlushMode in effect for this query. By default, the query inherits the FlushMode of the Stage.Session from which is originates.
    
    See Also:
    
    Stage.Session.getFlushMode()
  - setLockMode
```
Stage.SelectionQuery<R> setLockMode(LockMode lockMode)
```
    Set the LockMode to use for the whole query.
  - setLockMode
```
default Stage.SelectionQuery<R> setLockMode(LockModeType lockModeType)
```
    Set the LockModeType to use for the whole query.
  - setLockMode
```
Stage.SelectionQuery<R> setLockMode(String alias,
                                    LockMode lockMode)
```
    Set the LockMode to use for specified alias (as defined in the query's from clause).
    
    Parameters:
    
    alias - the from clause alias
    
    lockMode - the requested LockMode
    
    See Also:
    
    Query.setLockMode(String,LockMode)
  - setLockMode
```
default Stage.SelectionQuery<R> setLockMode(String alias,
                                            LockModeType lockModeType)
```
    Set the LockModeType to use for specified alias (as defined in the query's from clause).
    
    Parameters:
    
    alias - the from clause alias
    
    lockModeType - the requested LockModeType
    
    See Also:
    
    Query.setLockMode(String,LockMode)
  - setOrder
```
Stage.SelectionQuery<R> setOrder(List<Order<? super R>> orderList)
```
    If the result type of this query is an entity class, add one or more rules for ordering the query results.
    
    Parameters:
    
    orderList - one or more instances of Order
    
    See Also:
    
    Order, Query.setOrder(List)
  - setOrder
```
Stage.SelectionQuery<R> setOrder(Order<? super R> order)
```
    If the result type of this query is an entity class, add a rule for ordering the query results.
    
    Parameters:
    
    order - an instance of Order
    
    See Also:
    
    Order, Query.setOrder(Order)
  - setPlan
```
Stage.SelectionQuery<R> setPlan(EntityGraph<R> entityGraph)
```
    Set the EntityGraph that will be used as a fetch plan for the root entity returned by this query.
  - enableFetchProfile
```
Stage.SelectionQuery<R> enableFetchProfile(String profileName)
```
    Enable a fetch profile which will be in effect during execution of this query.
  - setParameter
```
Stage.SelectionQuery<R> setParameter(int parameter,
                                     Object argument)
```
    Description copied from interface: Stage.AbstractQuery
    
    Set the value of an ordinal parameter. Ordinal parameters are numbered from 1, and are specified in the query using placeholder tokens of form ?1, ?2, etc.
    
    Specified by:
    
    setParameter in interface Stage.AbstractQuery
    
    Parameters:
    
    parameter - an integer identifying the ordinal parameter
    
    argument - the argument to set
  - setParameter
```
Stage.SelectionQuery<R> setParameter(String parameter,
                                     Object argument)
```
    Description copied from interface: Stage.AbstractQuery
    
    Set the value of a named parameter. Named parameters are specified in the query using placeholder tokens of form :name.
    
    Specified by:
    
    setParameter in interface Stage.AbstractQuery
    
    Parameters:
    
    parameter - the name of the parameter
    
    argument - the argument to set
  - setParameter
```
<T> Stage.SelectionQuery<R> setParameter(Parameter<T> parameter,
                                         T argument)
```
    Description copied from interface: Stage.AbstractQuery
    
    Set the value of a typed parameter. Typed parameters are obtained from the JPA CriteriaBuilder, which may itself be obtained by calling Stage.SessionFactory.getCriteriaBuilder().
    
    Specified by:
    
    setParameter in interface Stage.AbstractQuery
    
    Parameters:
    
    parameter - the parameter
    
    argument - the argument to set
    
    See Also:
    
    CriteriaBuilder.parameter(Class)
  - setComment
```
Stage.SelectionQuery<R> setComment(String comment)
```
    Description copied from interface: Stage.AbstractQuery
    
    Set the comment for this query. This comment will be prepended to the SQL query sent to the database.
    
    Specified by:
    
    setComment in interface Stage.AbstractQuery
    
    Parameters:
    
    comment - The human-readable comment

Interface Stage.SelectionQuery<R>

Method Summary

Methods inherited from interface org.hibernate.reactive.stage.Stage.AbstractQuery

Method Detail

setMaxResults

setFirstResult

setPage

getMaxResults

getFirstResult

getSingleResult

getSingleResultOrNull

getResultCount

getResultList

setReadOnly

isReadOnly

setCacheable

isCacheable

setCacheRegion

getCacheRegion

setCacheMode

setCacheStoreMode

setCacheRetrieveMode

getCacheStoreMode

getCacheRetrieveMode

getCacheMode

setFlushMode

setFlushMode

getFlushMode

setLockMode

setLockMode

setLockMode

setLockMode

setOrder

setOrder

setPlan

enableFetchProfile

setParameter

setParameter

setParameter

setComment