Package org.hibernate.reactive.stage

Interface Stage.Query<R>

All Superinterfaces:

Stage.AbstractQuery, Stage.MutationQuery, Stage.SelectionQuery<R>

Enclosing interface:

Stage

public static interface Stage.Query<R>
extends Stage.SelectionQuery<R>, Stage.MutationQuery

Method Summary

Modifier and Type	Method	Description
Stage.Query<R>	setCacheable(boolean cacheable)	Enable or disable caching of this query result set in the second-level query cache.
Stage.Query<R>	setCacheMode(CacheMode cacheMode)	Set the current CacheMode in effect while this query is being executed.
Stage.Query<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.Query<R>	setCacheRetrieveMode(jakarta.persistence.CacheRetrieveMode cacheRetrieveMode)	Set the current CacheRetrieveMode in effect while this query is being executed.
default Stage.Query<R>	setCacheStoreMode(jakarta.persistence.CacheStoreMode cacheStoreMode)	Set the current CacheStoreMode in effect while this query is being executed.
Stage.Query<R>	setComment(String comment)	Set the comment for this query.
Stage.Query<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.Query<R>	setFlushMode(jakarta.persistence.FlushModeType flushModeType)	Set the current FlushModeType in effect while this query is being executed.
Stage.Query<R>	setFlushMode(FlushMode flushMode)	Set the current FlushMode in effect while this query is being executed.
default Stage.Query<R>	setLockMode(jakarta.persistence.LockModeType lockModeType)	Set the LockModeType to use for the whole query.
default Stage.Query<R>	setLockMode(String alias, jakarta.persistence.LockModeType lockModeType)	Set the LockModeType to use for specified alias (as defined in the query's from clause).
Stage.Query<R>	setLockMode(String alias, LockMode lockMode)	Set the LockMode to use for specified alias (as defined in the query's from clause).
Stage.Query<R>	setLockMode(LockMode lockMode)	Set the LockMode to use for the whole query.
Stage.Query<R>	setMaxResults(int maxResults)	Set the maximum number of results that may be returned by this query when executed.
Stage.Query<R>	setParameter(int parameter, Object argument)	Set the value of an ordinal parameter.
<T> Stage.Query<R>	setParameter(jakarta.persistence.Parameter<T> parameter, T argument)	Set the value of a typed parameter.
Stage.Query<R>	setParameter(String parameter, Object argument)	Set the value of a named parameter.
Stage.Query<R>	setPlan(jakarta.persistence.EntityGraph<R> entityGraph)	Set the EntityGraph that will be used as a fetch plan for the root entity returned by this query.
Stage.Query<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

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

executeUpdate

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

enableFetchProfile, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFirstResult, getFlushMode, getMaxResults, getResultCount, getResultList, getSingleResult, getSingleResultOrNull, isCacheable, isReadOnly, setPage

Method Details

setMaxResults

Stage.Query<R> setMaxResults(int maxResults)

Description copied from interface: Stage.SelectionQuery

Set the maximum number of results that may be returned by this query when executed.

Specified by:

setMaxResults in interface Stage.SelectionQuery<R>

setFirstResult

Stage.Query<R> setFirstResult(int firstResult)

Description copied from interface: Stage.SelectionQuery

Set the position of the first result that may be returned by this query when executed, where the results are numbered from 0.

Specified by:

setFirstResult in interface Stage.SelectionQuery<R>

setReadOnly

Stage.Query<R> setReadOnly(boolean readOnly)

Description copied from interface: Stage.SelectionQuery

Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context.

Specified by:

setReadOnly in interface Stage.SelectionQuery<R>

See Also:

• Stage.Session.setDefaultReadOnly(boolean)

setCacheable

Stage.Query<R> setCacheable(boolean cacheable)

Description copied from interface: Stage.SelectionQuery

Enable or disable caching of this query result set in the second-level query cache.

Specified by:

setCacheable in interface Stage.SelectionQuery<R>

Parameters:

cacheable - true if this query is cacheable

setCacheRegion

Stage.Query<R> setCacheRegion(String cacheRegion)

Description copied from interface: Stage.SelectionQuery

Set the name of the cache region in which to store this query result set if caching is enabled.

Specified by:

setCacheRegion in interface Stage.SelectionQuery<R>

Parameters:

cacheRegion - the name of the cache region

setCacheMode

Stage.Query<R> setCacheMode(CacheMode cacheMode)

Description copied from interface: Stage.SelectionQuery

Set the current CacheMode in effect while this query is being executed.

Specified by:

setCacheMode in interface Stage.SelectionQuery<R>

setCacheStoreMode

default Stage.Query<R> setCacheStoreMode(jakarta.persistence.CacheStoreMode cacheStoreMode)

Description copied from interface: Stage.SelectionQuery

Set the current CacheStoreMode in effect while this query is being executed.

Specified by:

setCacheStoreMode in interface Stage.SelectionQuery<R>

setCacheRetrieveMode

default Stage.Query<R> setCacheRetrieveMode(jakarta.persistence.CacheRetrieveMode cacheRetrieveMode)

Description copied from interface: Stage.SelectionQuery

Set the current CacheRetrieveMode in effect while this query is being executed.

Specified by:

setCacheRetrieveMode in interface Stage.SelectionQuery<R>

setFlushMode

Stage.Query<R> setFlushMode(FlushMode flushMode)

Description copied from interface: Stage.SelectionQuery

Set the current FlushMode in effect while this query is being executed.

Specified by:

setFlushMode in interface Stage.SelectionQuery<R>

setFlushMode

default Stage.Query<R> setFlushMode(jakarta.persistence.FlushModeType flushModeType)

Description copied from interface: Stage.SelectionQuery

Set the current FlushModeType in effect while this query is being executed.

Specified by:

setFlushMode in interface Stage.SelectionQuery<R>

setLockMode

Stage.Query<R> setLockMode(LockMode lockMode)

Description copied from interface: Stage.SelectionQuery

Set the LockMode to use for the whole query.

Specified by:

setLockMode in interface Stage.SelectionQuery<R>

setLockMode

default Stage.Query<R> setLockMode(jakarta.persistence.LockModeType lockModeType)

Description copied from interface: Stage.SelectionQuery

Set the LockModeType to use for the whole query.

Specified by:

setLockMode in interface Stage.SelectionQuery<R>

setLockMode

Stage.Query<R> setLockMode(String alias,
 LockMode lockMode)

Description copied from interface: Stage.SelectionQuery

Set the LockMode to use for specified alias (as defined in the query's from clause).

Specified by:

setLockMode in interface Stage.SelectionQuery<R>

Parameters:

alias - the from clause alias

lockMode - the requested LockMode

See Also:

• Query.setLockMode(String,LockMode)

setLockMode

default Stage.Query<R> setLockMode(String alias,
 jakarta.persistence.LockModeType lockModeType)

Description copied from interface: Stage.SelectionQuery

Set the LockModeType to use for specified alias (as defined in the query's from clause).

Specified by:

setLockMode in interface Stage.SelectionQuery<R>

Parameters:

alias - the from clause alias

lockModeType - the requested LockModeType

See Also:

• Query.setLockMode(String,LockMode)

setPlan

Stage.Query<R> setPlan(jakarta.persistence.EntityGraph<R> entityGraph)

Description copied from interface: Stage.SelectionQuery

Set the EntityGraph that will be used as a fetch plan for the root entity returned by this query.

Specified by:

setPlan in interface Stage.SelectionQuery<R>

setParameter

Stage.Query<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

Specified by:

setParameter in interface Stage.MutationQuery

Specified by:

setParameter in interface Stage.SelectionQuery<R>

Parameters:

parameter - an integer identifying the ordinal parameter

argument - the argument to set

setParameter

Stage.Query<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

Specified by:

setParameter in interface Stage.MutationQuery

Specified by:

setParameter in interface Stage.SelectionQuery<R>

Parameters:

parameter - the name of the parameter

argument - the argument to set

setParameter

<T> Stage.Query<R> setParameter(jakarta.persistence.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

Specified by:

setParameter in interface Stage.MutationQuery

Specified by:

setParameter in interface Stage.SelectionQuery<R>

Parameters:

parameter - the parameter

argument - the argument to set

See Also:

• CriteriaBuilder.parameter(Class)

setComment

Stage.Query<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

Specified by:

setComment in interface Stage.MutationQuery

Specified by:

setComment in interface Stage.SelectionQuery<R>

Parameters:

comment - The human-readable comment