Package org.hibernate.reactive.mutiny

Interface Mutiny.Query<R>

All Superinterfaces:

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

All Known Implementing Classes:

MutinyQueryImpl

Enclosing interface:

Mutiny

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

Method Summary

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

getComment

Methods inherited from interface org.hibernate.reactive.mutiny.Mutiny.MutationQuery

executeUpdate

Methods inherited from interface org.hibernate.reactive.mutiny.Mutiny.SelectionQuery

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

Method Details

setMaxResults

Mutiny.Query<R> setMaxResults(int maxResults)

Description copied from interface: Mutiny.SelectionQuery

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

Specified by:

setMaxResults in interface Mutiny.SelectionQuery<R>

setFirstResult

Mutiny.Query<R> setFirstResult(int firstResult)

Description copied from interface: Mutiny.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 Mutiny.SelectionQuery<R>

setReadOnly

Mutiny.Query<R> setReadOnly(boolean readOnly)

Description copied from interface: Mutiny.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 Mutiny.SelectionQuery<R>

See Also:

• Mutiny.Session.setDefaultReadOnly(boolean)

setCacheable

Mutiny.Query<R> setCacheable(boolean cacheable)

Description copied from interface: Mutiny.SelectionQuery

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

Specified by:

setCacheable in interface Mutiny.SelectionQuery<R>

Parameters:

cacheable - true if this query is cacheable

setCacheRegion

Mutiny.Query<R> setCacheRegion(String cacheRegion)

Description copied from interface: Mutiny.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 Mutiny.SelectionQuery<R>

Parameters:

cacheRegion - the name of the cache region

setCacheMode

Mutiny.Query<R> setCacheMode(org.hibernate.CacheMode cacheMode)

Description copied from interface: Mutiny.SelectionQuery

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

Specified by:

setCacheMode in interface Mutiny.SelectionQuery<R>

setCacheStoreMode

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

Description copied from interface: Mutiny.SelectionQuery

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

Specified by:

setCacheStoreMode in interface Mutiny.SelectionQuery<R>

setCacheRetrieveMode

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

Description copied from interface: Mutiny.SelectionQuery

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

Specified by:

setCacheRetrieveMode in interface Mutiny.SelectionQuery<R>

setFlushMode

Mutiny.Query<R> setFlushMode(org.hibernate.FlushMode flushMode)

Description copied from interface: Mutiny.SelectionQuery

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

Specified by:

setFlushMode in interface Mutiny.SelectionQuery<R>

setFlushMode

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

Description copied from interface: Mutiny.SelectionQuery

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

Specified by:

setFlushMode in interface Mutiny.SelectionQuery<R>

setLockMode

Mutiny.Query<R> setLockMode(org.hibernate.LockMode lockMode)

Description copied from interface: Mutiny.SelectionQuery

Set the LockMode to use for the whole query.

Specified by:

setLockMode in interface Mutiny.SelectionQuery<R>

setLockMode

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

Description copied from interface: Mutiny.SelectionQuery

Set the LockModeType to use for the whole query.

Specified by:

setLockMode in interface Mutiny.SelectionQuery<R>

setLockMode

Mutiny.Query<R> setLockMode(String alias,
 org.hibernate.LockMode lockMode)

Description copied from interface: Mutiny.SelectionQuery

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

Specified by:

setLockMode in interface Mutiny.SelectionQuery<R>

Parameters:

alias - the from clause alias

lockMode - the requested LockMode

See Also:

• Query.setLockMode(String,LockMode)

setLockMode

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

Description copied from interface: Mutiny.SelectionQuery

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

Specified by:

setLockMode in interface Mutiny.SelectionQuery<R>

Parameters:

alias - the from clause alias

lockModeType - the requested LockModeType

See Also:

• Query.setLockMode(String,LockMode)

setPlan

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

Description copied from interface: Mutiny.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 Mutiny.SelectionQuery<R>

setParameter

Mutiny.Query<R> setParameter(int parameter,
 Object argument)

Description copied from interface: Mutiny.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 Mutiny.AbstractQuery

Specified by:

setParameter in interface Mutiny.MutationQuery

Specified by:

setParameter in interface Mutiny.SelectionQuery<R>

Parameters:

parameter - an integer identifying the ordinal parameter

argument - the argument to set

setParameter

Mutiny.Query<R> setParameter(String parameter,
 Object argument)

Description copied from interface: Mutiny.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 Mutiny.AbstractQuery

Specified by:

setParameter in interface Mutiny.MutationQuery

Specified by:

setParameter in interface Mutiny.SelectionQuery<R>

Parameters:

parameter - the name of the parameter

argument - the argument to set

setParameter

<T> Mutiny.Query<R> setParameter(jakarta.persistence.Parameter<T> parameter,
 T argument)

Description copied from interface: Mutiny.AbstractQuery

Set the value of a typed parameter. Typed parameters are obtained from the JPA CriteriaBuilder, which may itself be obtained by calling Mutiny.SessionFactory.getCriteriaBuilder().

Specified by:

setParameter in interface Mutiny.AbstractQuery

Specified by:

setParameter in interface Mutiny.MutationQuery

Specified by:

setParameter in interface Mutiny.SelectionQuery<R>

Parameters:

parameter - the parameter

argument - the argument to set

See Also:

• CriteriaBuilder.parameter(Class)

setComment

Mutiny.Query<R> setComment(String comment)

Description copied from interface: Mutiny.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 Mutiny.AbstractQuery

Specified by:

setComment in interface Mutiny.MutationQuery

Specified by:

setComment in interface Mutiny.SelectionQuery<R>

Parameters:

comment - The human-readable comment

enableFetchProfile

Mutiny.Query<R> enableFetchProfile(String profileName)

Description copied from interface: Mutiny.SelectionQuery

Enable a fetch profile which will be in effect during execution of this query.

Specified by:

enableFetchProfile in interface Mutiny.SelectionQuery<R>