Package org.hibernate.query

Interface Query<R>

Type Parameters:: R - The result type, for typed queries, orObject for untyped queries

All Superinterfaces:: CommonQueryContract,MutationQuery,Query,SelectionQuery<R>,TypedQuery<R>

All Known Subinterfaces:: NativeQuery<T>,NativeQueryImplementor<R>,ProcedureCallImplementor<R>,QueryImplementor<R>,SqmQueryImplementor<R>

All Known Implementing Classes:: AbstractQuery,NativeQueryImpl,ProcedureCallImpl,QuerySqmImpl

@Incubatingpublic interfaceQuery<R>extendsSelectionQuery<R>,MutationQuery,TypedQuery<R>

Within the context of an activesession, an instance of this type represents an executable query, either:

a query written in HQL,
a named query written in HQL or native SQL, or
acriteria query.

The subtypeNativeQuery represents a query written in native SQL.

This type simply mixes theTypedQuery interface defined by JPA withSelectionQuery andMutationQuery. Unfortunately, JPA does not distinguish betweenselection queries andmutation queries, so we lose that distinction here. However, everyQuery may logically be classified as one or the other.

AQuery may be obtained from theSession by calling:

QueryProducer.createQuery(String, Class), passing the HQL as a string,
QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaQuery), passing acriteria object, or
QueryProducer.createNamedQuery(String, Class) passing the name of a query defined usingNamedQuery orNamedNativeQuery.

AQuery controls how a query is executed, and allows arguments to be bound to its parameters.

Selection queries are usually executed usinggetResultList() orgetSingleResult().
The methodssetMaxResults(int) andsetFirstResult(int) control limits and pagination.
The various overloads ofsetParameter(String, Object) andsetParameter(int, Object) allow arguments to be bound to named and ordinal parameters defined by the query.

Note that this interface offers no real advantages overSelectionQuery except for compatibility with the JPA-definedTypedQuery interface.

See Also:

QueryProducer

Method Summary
Modifier and Type
Method
Description
Query<R>
addQueryHint(String hint)
Add a database query hint to the SQL query.
defaultQuery<R>
applyFetchGraph(RootGraph graph)
Deprecated.
UsesetEntityGraph(EntityGraph, GraphSemantic) which is more type safe
Query<R>
applyGraph(RootGraph graph,GraphSemantic semantic)
Deprecated.
UsesetEntityGraph(EntityGraph, GraphSemantic) which is more type safe
defaultQuery<R>
applyLoadGraph(RootGraph graph)
Deprecated.
UsesetEntityGraph(EntityGraph, GraphSemantic) which is more type safe
Query<R>
disableFetchProfile(String profileName)
Disable thefetch profile with the given name in this session.
Query<R>
enableFetchProfile(String profileName)
Enable thefetch profile with the given name during execution of this query.
int
executeUpdate()
Execute an insert, update, or delete statement, and return the number of affected entities.
String
getComment()
Obtain the comment currently associated with this query.
LockOptions
getLockOptions()
Deprecated, for removal: This API element is subject to removal in a future version.
SinceLockOptions is transitioning to a new role as an SPI.
QueryOptions
getQueryOptions()
Get the execution options for thisQuery.
String
getQueryString()
The query as a string, ornull in the case of a criteria query.
defaultList<R>
getResultList()
Execute the query and return the query results as aList.
defaultStream<R>
getResultStream()
Execute the query and return the query results as aStream.
SharedSessionContract
getSession()
Get theQueryProducer which produced thisQuery, that is, theSession orStatelessSession that was used to create thisQuery instance.
R
getSingleResult()
Execute the query and return the single result of the query, throwing an exception if the query returns no results.
List<R>
list()
Execute the query and return the query results as aList.
ScrollableResults<R>
scroll()
Execute the query and return the results in ascrollable form.
ScrollableResults<R>
scroll(ScrollMode scrollMode)
Execute the query and return the results in ascrollable form.
Query<R>
setCacheable(boolean cacheable)
Enable/disable second level query (result) caching for this query.
Query<R>
setCacheMode(CacheMode cacheMode)
Set the currentCacheMode in effect for this query.
Query<R>
setCacheRegion(String cacheRegion)
Set the name of the cache region where query results should be cached (assumingSelectionQuery.isCacheable()).
Query<R>
setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Query<R>
setCacheStoreMode(CacheStoreMode cacheStoreMode)

Query<R>
setComment(String comment)
Set the comment for this query.
Query<R>
setEntityGraph(EntityGraph<? superR> graph,GraphSemantic semantic)
Apply anEntityGraph to the query.
Query<R>
setFetchSize(int fetchSize)
Sets a JDBC fetch size hint for the query.
Query<R>
setFirstResult(int startPosition)
Set the first query result row to return.
Query<R>
setFlushMode(FlushModeType flushMode)
Deprecated.
Query<R>
setHibernateFlushMode(FlushMode flushMode)
Deprecated.
Query<R>
setHint(String hintName,Object value)
Set a hint.
Query<R>
setLockMode(LockModeType lockMode)
Specify the rootLockModeType for the query
Query<R>
setLockMode(String alias,LockMode lockMode)
Set theLockMode to use for particular alias defined in theFROM clause of the query.
Query<R>
setLockOptions(LockOptions lockOptions)
Deprecated, for removal: This API element is subject to removal in a future version.
Use one ofsetLockMode(LockModeType),SelectionQuery.setHibernateLockMode(org.hibernate.LockMode),setLockScope(jakarta.persistence.PessimisticLockScope) and/orsetTimeout(jakarta.persistence.Timeout) instead.
Query<R>
setLockScope(PessimisticLockScope lockScope)
Apply a scope to any pessimistic locking applied to the query.
Query<R>
setMaxResults(int maxResults)
Set the maximum number of query result rows to return.
defaultQuery<R>
setPage(Page page)
Set thepage of results to return.
Query<R>
setParameter(int parameter,Object argument)
Bind the given argument to an ordinal query parameter.
Query<R>
setParameter(int parameter,Instant argument,TemporalType temporalType)
Deprecated.
Query<R>
setParameter(int parameter,Calendar argument,TemporalType temporalType)
Deprecated.
Query<R>
setParameter(int parameter,Date argument,TemporalType temporalType)
Deprecated.
 Query<R>
setParameter(int parameter, P argument,Type type)
Bind the given argument to an ordinal query parameter using the givenType.
 Query<R>
setParameter(int parameter, P argument,Class type)
Bind the given argument to an ordinal query parameter using the given Class reference to attempt to determine theType to use.
Query<R>
setParameter(Parameter<Calendar> parameter,Calendar argument,TemporalType temporalType)
Deprecated.
Query<R>
setParameter(Parameter<Date> parameter,Date argument,TemporalType temporalType)
Deprecated.
<T> Query<R>
setParameter(Parameter<T> parameter, T argument)
Query override
Query<R>
setParameter(String parameter,Object argument)
Bind the given argument to a named query parameter.
Query<R>
setParameter(String parameter,Instant argument,TemporalType temporalType)
Deprecated.
Query<R>
setParameter(String parameter,Calendar argument,TemporalType temporalType)
Deprecated.
Query<R>
setParameter(String parameter,Date argument,TemporalType temporalType)
Deprecated.
 Query<R>
setParameter(String parameter, P argument,Type type)
Bind the given argument to a named query parameter using the givenType.
 Query<R>
setParameter(String parameter, P argument,Class type)
Bind the given argument to a named query parameter using the given Class reference to attempt to determine theType to use.
 Query<R>
setParameter(QueryParameter parameter, P argument,Type type)
Bind an argument to the query parameter represented by the givenQueryParameter using the givenType.
 Query<R>
setParameter(QueryParameter parameter, P argument,Class type)
Bind an argument to the query parameter represented by the givenQueryParameter using the given Class reference to attempt to determine theType to use.
<T> Query<R>
setParameter(QueryParameter<T> parameter, T argument)
Bind an argument to the query parameter represented by the givenQueryParameter.
Query<R>
setParameterList(int parameter,Object[] arguments)
Bind multiple arguments to an ordinal query parameter.
Query<R>
setParameterList(int parameter,Collection arguments)
Bind multiple arguments to an ordinal query parameter.
 Query<R>
setParameterList(int parameter,Collection<? extends P> arguments,Type type)
Bind multiple arguments to an ordinal query parameter using the givenType.
 Query<R>
setParameterList(int parameter,Collection<? extends P> arguments,Class javaType)
Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine theType to use.
 Query<R>
setParameterList(int parameter, P[] arguments,Type type)
Bind multiple arguments to an ordinal query parameter using the givenType.
 Query<R>
setParameterList(int parameter, P[] arguments,Class javaType)
Bind multiple arguments to an ordinal query parameter using the givenClass reference to attempt to determine theType to use.
Query<R>
setParameterList(String parameter,Object[] values)
Bind multiple arguments to a named query parameter.
Query<R>
setParameterList(String parameter,Collection arguments)
Bind multiple arguments to a named query parameter.
 Query<R>
setParameterList(String parameter,Collection<? extends P> arguments,Type type)
Bind multiple arguments to a named query parameter using the givenType.
 Query<R>
setParameterList(String parameter,Collection<? extends P> arguments,Class javaType)
Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theType to use.
 Query<R>
setParameterList(String parameter, P[] arguments,Type type)
Bind multiple arguments to a named query parameter using the givenType.
 Query<R>
setParameterList(String parameter, P[] arguments,Class javaType)
Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theType to use.
 Query<R>
setParameterList(QueryParameter parameter,Collection<? extends P> arguments)
Bind multiple arguments to the query parameter represented by the givenQueryParameter.
 Query<R>
setParameterList(QueryParameter parameter,Collection<? extends P> arguments,Type type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter, inferring theType.
 Query<R>
setParameterList(QueryParameter parameter,Collection<? extends P> arguments,Class javaType)
Bind multiple arguments to the query parameter represented by the givenQueryParameter using the given Class reference to attempt to determine theType to use.
 Query<R>
setParameterList(QueryParameter parameter, P[] arguments)
Bind multiple arguments to the query parameter represented by the givenQueryParameter.
 Query<R>
setParameterList(QueryParameter parameter, P[] arguments,Type type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter, inferring theType.
 Query<R>
setParameterList(QueryParameter parameter, P[] arguments,Class javaType)
Bind multiple arguments to the query parameter represented by the givenQueryParameter using the givenClass reference to attempt to determine theType to use.
Query<R>
setProperties(Object bean)
Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
Query<R>
setProperties(Map bean)
Bind the values of the givenMap for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
Query<R>
setQueryFlushMode(QueryFlushMode queryFlushMode)
Set theQueryFlushMode to use for this query.
Query<R>
setReadOnly(boolean readOnly)
Set the read-only/modifiable mode for entities and proxies loaded by thisQuery.
Query<R>
setResultListTransformer(ResultListTransformer<R> transformer)
Set aResultListTransformer.
default <T> Query<T>
setResultTransformer(ResultTransformer<T> transformer)
Deprecated.
UsesetTupleTransformer(org.hibernate.query.TupleTransformer<T>) orsetResultListTransformer(org.hibernate.query.ResultListTransformer<R>)
Query<R>
setTimeout(int timeout)
Set the query timeoutin seconds.
Query<R>
setTimeout(Timeout timeout)
Apply a timeout to the corresponding database query.
<T> Query<T>
setTupleTransformer(TupleTransformer<T> transformer)
Set aTupleTransformer.
defaultStream<R>
stream()
Execute the query and return the query results as aStream.
R
uniqueResult()
Execute the query and return the single result of the query, ornull if the query returns no results.
Optional<R>
uniqueResultOptional()
Execute the query and return the single result of the query as an instance ofOptional.
Methods inherited from interface org.hibernate.query.CommonQueryContract
getFlushMode,getHibernateFlushMode,getParameterMetadata,getQueryFlushMode,getTimeout
Methods inherited from interface jakarta.persistence.Query
getCacheRetrieveMode,getCacheStoreMode,getFirstResult,getFlushMode,getHints,getLockMode,getMaxResults,getParameter,getParameter,getParameter,getParameter,getParameters,getParameterValue,getParameterValue,getParameterValue,getTimeout,isBound,unwrap
Methods inherited from interface org.hibernate.query.SelectionQuery
getCacheMode,getCacheRegion,getCacheRetrieveMode,getCacheStoreMode,getFetchSize,getFirstResult,getHibernateLockMode,getKeyedResultList,getLockMode,getMaxResults,getResultCount,getSingleResultOrNull,isCacheable,isQueryPlanCacheable,isReadOnly,setFollowOnLocking,setHibernateLockMode,setQueryPlanCacheable
Methods inherited from interface jakarta.persistence.TypedQuery
getSingleResultOrNull,setTimeout

Method Details
- list
 List<R> list()
 Execute the query and return the query results as aList. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of typeObject[].
 Specified by:
 list in interface SelectionQuery<R>
 Returns:
 the result list
- getResultList
 default List<R> getResultList()
 Execute the query and return the query results as aList. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of typeObject[].
 Specified by:
 getResultList in interface Query
 Specified by:
 getResultList in interface SelectionQuery<R>
 Specified by:
 getResultList in interface TypedQuery<R>
 Returns:
 the results as a list
 Implementation Note:
 Delegates tolist()
- scroll
 ScrollableResults<R> scroll()
 Execute the query and return the results in ascrollable form.
 This overload simply callsscroll(ScrollMode) using thedialect default scroll mode.
 Specified by:
 scroll in interface SelectionQuery<R>
 See Also:
 SelectionQuery.scroll(ScrollMode)
 API Note:
 The exact behavior of this method depends somewhat on the level of JDBC driver support for scrollableResultSets, and so is not very portable between database.
- scroll
 ScrollableResults<R> scroll(ScrollMode scrollMode)
 Execute the query and return the results in ascrollable form. The capabilities of the returnedScrollableResults depend on the specifiedScrollMode.
 Specified by:
 scroll in interface SelectionQuery<R>
 API Note:
 The exact behavior of this method depends somewhat on the level of JDBC driver support for scrollableResultSets, and so is not very portable between database.
- getResultStream
 default Stream<R> getResultStream()
 Execute the query and return the query results as aStream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of typeObject[].
 The client should callBaseStream.close() after processing the stream so that resources are freed as soon as possible.
 Specified by:
 getResultStream in interface Query
 Specified by:
 getResultStream in interface SelectionQuery<R>
 Specified by:
 getResultStream in interface TypedQuery<R>
 Returns:
 The results as aStream
 Implementation Note:
 Delegates tostream(), which in turn delegates to this method. Implementors should implement at least one of these methods.
- stream
 default Stream<R> stream()
 Execute the query and return the query results as aStream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of typeObject[].
 The client should callBaseStream.close() after processing the stream so that resources are freed as soon as possible.
 Specified by:
 stream in interface SelectionQuery<R>
 Returns:
 The results as aStream
 Since:
 5.2
- uniqueResult
 R uniqueResult()
 Execute the query and return the single result of the query, ornull if the query returns no results.
 Specified by:
 uniqueResult in interface SelectionQuery<R>
 Returns:
 the single result ornull if there is no result to return
 Throws:
 NonUniqueResultException - if there is more than one matching result
- getSingleResult
 R getSingleResult()
 Execute the query and return the single result of the query, throwing an exception if the query returns no results.
 Specified by:
 getSingleResult in interface Query
 Specified by:
 getSingleResult in interface SelectionQuery<R>
 Specified by:
 getSingleResult in interface TypedQuery<R>
 Returns:
 the single result, only if there is exactly one
 Throws:
 NonUniqueResultException - if there is more than one matching result
 NoResultException - if there is no result to return
- uniqueResultOptional
 Optional<R> uniqueResultOptional()
 Execute the query and return the single result of the query as an instance ofOptional.
 Specified by:
 uniqueResultOptional in interface SelectionQuery<R>
 Returns:
 the single result as anOptional
 Throws:
 NonUniqueResultException - if there is more than one matching result
- executeUpdate
 int executeUpdate()
 Execute an insert, update, or delete statement, and return the number of affected entities.
 For use with instances ofMutationQuery created usingQueryProducer.createMutationQuery(String),QueryProducer.createNamedMutationQuery(String),QueryProducer.createNativeMutationQuery(String),QueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaUpdate), orQueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaDelete).
 Specified by:
 executeUpdate in interface MutationQuery
 Specified by:
 executeUpdate in interface Query
 Returns:
 the number of affected entity instances (may differ from the number of affected rows)
 See Also:
 QueryProducer.createMutationQuery(java.lang.String)
 QueryProducer.createMutationQuery(String)
 QueryProducer.createNamedMutationQuery(String)
 QueryProducer.createNativeMutationQuery(String)
 QueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaUpdate)
 QueryProducer.createMutationQuery(jakarta.persistence.criteria.CriteriaDelete)
 Query.executeUpdate()
 API Note:
 This method is needed because this interface extendsQuery, which defines this method. SeeMutationQuery andSelectionQuery.
- getSession
 SharedSessionContract getSession()
 Get theQueryProducer which produced thisQuery, that is, theSession orStatelessSession that was used to create thisQuery instance.
 Returns:
 The producer of this query
- getQueryString
 String getQueryString()
 The query as a string, ornull in the case of a criteria query.
- applyGraph
 @Deprecated(since="7.0")Query<R> applyGraph(RootGraph graph,GraphSemantic semantic)
 Deprecated.
 UsesetEntityGraph(EntityGraph, GraphSemantic) which is more type safe
 Apply the given graph using the given semantic
 Parameters:
 graph - The graph to apply.
 semantic - The semantic to use when applying the graph
- applyFetchGraph
 @Deprecated(since="7.0")default Query<R> applyFetchGraph(RootGraph graph)
 Deprecated.
 UsesetEntityGraph(EntityGraph, GraphSemantic) which is more type safe
 Apply the given graph usingfetch semantics.
 API Note:
 This method callsapplyGraph(RootGraph, GraphSemantic) usingGraphSemantic.FETCH as the semantic.
- applyLoadGraph
 @Deprecated(since="7.0")default Query<R> applyLoadGraph(RootGraph graph)
 Deprecated.
 UsesetEntityGraph(EntityGraph, GraphSemantic) which is more type safe
 Apply the given graph usingload semantics.
 API Note:
 This method callsapplyGraph(RootGraph, GraphSemantic) usingGraphSemantic.LOAD as the semantic.
- getComment
 String getComment()
 Obtain the comment currently associated with this query.
 If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.
 SQL commenting may be enabled using the configuration property"hibernate.use_sql_comments".
 Specified by:
 getComment in interface CommonQueryContract
 Returns:
 The comment.
- setComment
 Query<R> setComment(String comment)
 Set the comment for this query.
 If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.
 SQL commenting may be enabled using the configuration property"hibernate.use_sql_comments".
 Specified by:
 setComment in interface CommonQueryContract
 Specified by:
 setComment in interface MutationQuery
 Specified by:
 setComment in interface SelectionQuery<R>
 Parameters:
 comment - The human-readable comment
 Returns:
 this, for method chaining
 See Also:
 getComment()
- addQueryHint
 Query<R> addQueryHint(String hint)
 Add a database query hint to the SQL query.
 A database hint is a completely different concept to a JPA hint specified usingQueryHint orQuery.getHints(). These are hints to the JPA provider.
 Multiple query hints may be specified. The operationDialect.getQueryHintString(String, List) determines how the hint is actually added to the SQL query.
 Parameters:
 hint - The database specific query hint to add.
- getLockOptions
 @Deprecated(since="7.0",forRemoval=true)LockOptions getLockOptions()
 Deprecated, for removal: This API element is subject to removal in a future version.
 SinceLockOptions is transitioning to a new role as an SPI.
 Obtains theLockOptions in effect for this query.
 Specified by:
 getLockOptions in interface SelectionQuery<R>
 Returns:
 TheLockOptions currently in effect
 See Also:
 LockOptions
- setLockOptions
 @Deprecated(since="7.0",forRemoval=true)Query<R> setLockOptions(LockOptions lockOptions)
 Deprecated, for removal: This API element is subject to removal in a future version.
 Use one ofsetLockMode(LockModeType),SelectionQuery.setHibernateLockMode(org.hibernate.LockMode),setLockScope(jakarta.persistence.PessimisticLockScope) and/orsetTimeout(jakarta.persistence.Timeout) instead.
 Apply the givenlock options to this query. Alias-specific lock modes in the given lock options are merged with any alias-specific lock mode which have already beenset. If a lock mode has already been specified for an alias that is among the aliases in the given lock options, the lock mode specified in the given lock options overrides the lock mode that was already set.
 Parameters:
 lockOptions - The lock options to apply to the query.
 Returns:
 this, for method chaining
 See Also:
 getLockOptions()
- setLockMode
 Query<R> setLockMode(String alias,LockMode lockMode)
 Set theLockMode to use for particular alias defined in theFROM clause of the query.
 The alias-specific lock modes specified here are added to theLockOptions.
 The effect of alias-specific locking is quite dependent on the driver and database. For maximum portability, the given lock mode should beLockMode.PESSIMISTIC_WRITE.
 Specified by:
 setLockMode in interface SelectionQuery<R>
 Parameters:
 alias - A query alias
 lockMode - The lock mode to apply
 Returns:
 this, for method chaining
 See Also:
 getLockOptions()
- setTimeout
 Query<R> setTimeout(Timeout timeout)
 Apply a timeout to the corresponding database query.
 Specified by:
 setTimeout in interface CommonQueryContract
 Parameters:
 timeout - The timeout to apply
 Returns:
 this, for method chaining
- setLockScope
 Query<R> setLockScope(PessimisticLockScope lockScope)
 Apply a scope to any pessimistic locking applied to the query.
 Specified by:
 setLockScope in interface SelectionQuery<R>
 Parameters:
 lockScope - The lock scope to apply
 Returns:
 this, for method chaining
- setTupleTransformer
 <T> Query<T> setTupleTransformer(TupleTransformer<T> transformer)
 Set aTupleTransformer.
 Specified by:
 setTupleTransformer in interface SelectionQuery<R>
- setResultListTransformer
 Query<R> setResultListTransformer(ResultListTransformer<R> transformer)
 Set aResultListTransformer.
 Specified by:
 setResultListTransformer in interface SelectionQuery<R>
- getQueryOptions
 QueryOptions getQueryOptions()
 Get the execution options for thisQuery. Many of the setters of this object update the state of the returnedQueryOptions. This is useful because it gives access to s primitive value in its (nullable) wrapper form, rather than the primitive form as required by JPA. This allows us to distinguish whether a value has been explicitly set by the client.
 Returns:
 Return the encapsulation of this query's options.
- setParameter
 Query<R> setParameter(String parameter,Object argument)
 Bind the given argument to a named query parameter.
 If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms accept a "type".
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface Query
 Specified by:
 setParameter in interface SelectionQuery<R>
 Specified by:
 setParameter in interface TypedQuery<R>
 See Also:
 setParameter(String, Object, Class)
 setParameter(String, Object, Type)
- setParameter
 Query<R> setParameter(String parameter, P argument,Class type)
 Bind the given argument to a named query parameter using the given Class reference to attempt to determine theType to use. If unable to determine an appropriateType,setParameter(String, Object) is used.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface SelectionQuery<R>
 See Also:
 setParameter(String, Object, Type)
- setParameter
 Query<R> setParameter(String parameter, P argument,Type type)
 Bind the given argument to a named query parameter using the givenType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface SelectionQuery<R>
- setParameter
 @Deprecated(since="7")Query<R> setParameter(String parameter,Instant argument,TemporalType temporalType)
 Deprecated.
 Bind anInstant value to the named query parameter using just the portion indicated by the givenTemporalType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface SelectionQuery<R>
- setParameter
 @Deprecated(since="7")Query<R> setParameter(String parameter,Calendar argument,TemporalType temporalType)
 Deprecated.
 Query override
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface Query
 Specified by:
 setParameter in interface SelectionQuery<R>
 Specified by:
 setParameter in interface TypedQuery<R>
 See Also:
 Query.setParameter(String, Calendar, TemporalType)
- setParameter
 @Deprecated(since="7")Query<R> setParameter(String parameter,Date argument,TemporalType temporalType)
 Deprecated.
 Query override
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface Query
 Specified by:
 setParameter in interface SelectionQuery<R>
 Specified by:
 setParameter in interface TypedQuery<R>
 See Also:
 Query.setParameter(String, Date, TemporalType)
- setParameter
 Query<R> setParameter(int parameter,Object argument)
 Bind the given argument to an ordinal query parameter.
 If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms which accepts a "type".
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface Query
 Specified by:
 setParameter in interface SelectionQuery<R>
 Specified by:
 setParameter in interface TypedQuery<R>
 See Also:
 setParameter(int, Object, Class)
 setParameter(int, Object, Type)
- setParameter
 Query<R> setParameter(int parameter, P argument,Class type)
 Bind the given argument to an ordinal query parameter using the given Class reference to attempt to determine theType to use. If unable to determine an appropriateType,setParameter(int, Object) is used.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface SelectionQuery<R>
 See Also:
 setParameter(int, Object, Type)
- setParameter
 Query<R> setParameter(int parameter, P argument,Type type)
 Bind the given argument to an ordinal query parameter using the givenType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface SelectionQuery<R>
- setParameter
 @Deprecated(since="7")Query<R> setParameter(int parameter,Instant argument,TemporalType temporalType)
 Deprecated.
 Bind anInstant value to the ordinal query parameter using just the portion indicated by the givenTemporalType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface SelectionQuery<R>
- setParameter
 @Deprecated(since="7")Query<R> setParameter(int parameter,Date argument,TemporalType temporalType)
 Deprecated.
 Query override
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface Query
 Specified by:
 setParameter in interface SelectionQuery<R>
 Specified by:
 setParameter in interface TypedQuery<R>
 See Also:
 Query.setParameter(int, Date, TemporalType)
- setParameter
 @Deprecated(since="7")Query<R> setParameter(int parameter,Calendar argument,TemporalType temporalType)
 Deprecated.
 Query override
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface Query
 Specified by:
 setParameter in interface SelectionQuery<R>
 Specified by:
 setParameter in interface TypedQuery<R>
 See Also:
 Query.setParameter(int, Calendar, TemporalType)
- setParameter
 <T> Query<R> setParameter(QueryParameter<T> parameter, T argument)
 Bind an argument to the query parameter represented by the givenQueryParameter.
 If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms which accepts a "type".
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface SelectionQuery<R>
 Parameters:
 parameter - the query parameter memento
 argument - the argument, which might be null
 Returns:
 this, for method chaining
 See Also:
 setParameter(QueryParameter, Object, Type)
- setParameter
 Query<R> setParameter(QueryParameter parameter, P argument,Class type)
 Bind an argument to the query parameter represented by the givenQueryParameter using the given Class reference to attempt to determine theType to use. If unable to determine an appropriateType,setParameter(QueryParameter, Object) is used
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface SelectionQuery<R>
 Parameters:
 parameter - the query parameter memento
 argument - the argument, which might be null
 type - aType representing the type of the parameter
 Returns:
 this, for method chaining
 See Also:
 setParameter(QueryParameter, Object, Type)
- setParameter
 Query<R> setParameter(QueryParameter parameter, P argument,Type type)
 Bind an argument to the query parameter represented by the givenQueryParameter using the givenType.
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface SelectionQuery<R>
 Parameters:
 parameter - the query parameter memento
 argument - the argument, which might be null
 type - anType representing the type of the parameter
 Returns:
 this, for method chaining
- setParameter
 <T> Query<R> setParameter(Parameter<T> parameter, T argument)
 Query override
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface Query
 Specified by:
 setParameter in interface SelectionQuery<R>
 Specified by:
 setParameter in interface TypedQuery<R>
 See Also:
 Query.setParameter(Parameter, Object)
- setParameter
 @Deprecated(since="7")Query<R> setParameter(Parameter<Calendar> parameter,Calendar argument,TemporalType temporalType)
 Deprecated.
 Query override
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface Query
 Specified by:
 setParameter in interface SelectionQuery<R>
 Specified by:
 setParameter in interface TypedQuery<R>
 See Also:
 Query.setParameter(Parameter, Calendar, TemporalType)
- setParameter
 @Deprecated(since="7")Query<R> setParameter(Parameter<Date> parameter,Date argument,TemporalType temporalType)
 Deprecated.
 Query override
 Specified by:
 setParameter in interface CommonQueryContract
 Specified by:
 setParameter in interface MutationQuery
 Specified by:
 setParameter in interface Query
 Specified by:
 setParameter in interface SelectionQuery<R>
 Specified by:
 setParameter in interface TypedQuery<R>
 See Also:
 Query.setParameter(Parameter, Date, TemporalType)
- setParameterList
 Query<R> setParameterList(String parameter,Collection arguments)
 Bind multiple arguments to a named query parameter.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 setParameterList(java.lang.String, java.util.Collection, Type)
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(String parameter,Collection<? extends P> arguments,Class javaType)
 Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theType to use. If unable to determine an appropriateType,setParameterList(String, Collection) is used.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 setParameterList(java.lang.String, java.util.Collection, Type)
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(String parameter,Collection<? extends P> arguments,Type type)
 Bind multiple arguments to a named query parameter using the givenType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(String parameter,Object[] values)
 Bind multiple arguments to a named query parameter.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(String parameter, P[] arguments,Class javaType)
 Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theType to use. If unable to determine an appropriateType,setParameterList(String, Collection) is used.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 setParameterList(java.lang.String, Object[], Type)
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(String parameter, P[] arguments,Type type)
 Bind multiple arguments to a named query parameter using the givenType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(int parameter,Collection arguments)
 Bind multiple arguments to an ordinal query parameter.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(int parameter,Collection<? extends P> arguments,Class javaType)
 Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine theType to use. If unable to determine an appropriateType,setParameterList(String, Collection) is used.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 setParameterList(int, Collection, Type)
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(int parameter,Collection<? extends P> arguments,Type type)
 Bind multiple arguments to an ordinal query parameter using the givenType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(int parameter,Object[] arguments)
 Bind multiple arguments to an ordinal query parameter.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(int parameter, P[] arguments,Class javaType)
 Bind multiple arguments to an ordinal query parameter using the givenClass reference to attempt to determine theType to use. If unable to determine an appropriateType,setParameterList(String, Collection) is used.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 setParameterList(int, Object[], Type)
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(int parameter, P[] arguments,Type type)
 Bind multiple arguments to an ordinal query parameter using the givenType.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(QueryParameter parameter,Collection<? extends P> arguments)
 Bind multiple arguments to the query parameter represented by the givenQueryParameter.
 The type of the parameter is inferred from the context in which it occurs, and from the type of the first given argument.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Parameters:
 parameter - the parameter memento
 arguments - a collection of arguments
 Returns:
 this, for method chaining
- setParameterList
 Query<R> setParameterList(QueryParameter parameter,Collection<? extends P> arguments,Class javaType)
 Bind multiple arguments to the query parameter represented by the givenQueryParameter using the given Class reference to attempt to determine theType to use. If unable to determine an appropriateType,setParameterList(String, Collection) is used.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 setParameterList(QueryParameter, java.util.Collection, Type)
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(QueryParameter parameter,Collection<? extends P> arguments,Type type)
 Bind multiple arguments to the query parameter represented by the givenQueryParameter, inferring theType.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(QueryParameter parameter, P[] arguments)
 Bind multiple arguments to the query parameter represented by the givenQueryParameter.
 The type of the parameter is inferred between the context in which it occurs, the type associated with the QueryParameter and the type of the first given argument.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Parameters:
 parameter - the parameter memento
 arguments - a collection of arguments
 Returns:
 this, for method chaining
- setParameterList
 Query<R> setParameterList(QueryParameter parameter, P[] arguments,Class javaType)
 Bind multiple arguments to the query parameter represented by the givenQueryParameter using the givenClass reference to attempt to determine theType to use. If unable to determine an appropriateType,setParameterList(String, Collection) is used.
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 See Also:
 setParameterList(QueryParameter, Object[], Type)
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setParameterList
 Query<R> setParameterList(QueryParameter parameter, P[] arguments,Type type)
 Bind multiple arguments to the query parameter represented by the givenQueryParameter, inferring theType.
 The "type mapping" for the binding is inferred from the type of the first collection element
 Specified by:
 setParameterList in interface CommonQueryContract
 Specified by:
 setParameterList in interface MutationQuery
 Specified by:
 setParameterList in interface SelectionQuery<R>
 Returns:
 this, for method chaining
 API Note:
 This is used for binding a list of values to an expression such asentity.field in (:values).
- setProperties
 Query<R> setProperties(Object bean)
 Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
 Specified by:
 setProperties in interface CommonQueryContract
 Specified by:
 setProperties in interface MutationQuery
 Specified by:
 setProperties in interface SelectionQuery<R>
 Parameters:
 bean - any JavaBean or POJO
 Returns:
 this, for method chaining
- setProperties
 Query<R> setProperties(Map bean)
 Bind the values of the givenMap for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
 Specified by:
 setProperties in interface CommonQueryContract
 Specified by:
 setProperties in interface MutationQuery
 Specified by:
 setProperties in interface SelectionQuery<R>
 Parameters:
 bean - aMap of names to arguments
 Returns:
 this, for method chaining
- setHibernateFlushMode
 @Deprecated(since="7")Query<R> setHibernateFlushMode(FlushMode flushMode)
 Deprecated.
 Description copied from interface: CommonQueryContract
 Set the currentFlushMode in effect for this query.
 Specified by:
 setHibernateFlushMode in interface CommonQueryContract
 Specified by:
 setHibernateFlushMode in interface MutationQuery
 Specified by:
 setHibernateFlushMode in interface SelectionQuery<R>
 See Also:
 CommonQueryContract.getQueryFlushMode()
 CommonQueryContract.getHibernateFlushMode()
 Session.getHibernateFlushMode()
- setQueryFlushMode
 Query<R> setQueryFlushMode(QueryFlushMode queryFlushMode)
 Description copied from interface: CommonQueryContract
 Set theQueryFlushMode to use for this query.
 Specified by:
 setQueryFlushMode in interface CommonQueryContract
 Specified by:
 setQueryFlushMode in interface MutationQuery
 Specified by:
 setQueryFlushMode in interface SelectionQuery<R>
 See Also:
 Session.getHibernateFlushMode()
- setCacheable
 Query<R> setCacheable(boolean cacheable)
 Description copied from interface: SelectionQuery
 Enable/disable second level query (result) caching for this query.
 Specified by:
 setCacheable in interface SelectionQuery<R>
 See Also:
 SelectionQuery.isCacheable()
- setCacheRegion
 Query<R> setCacheRegion(String cacheRegion)
 Description copied from interface: SelectionQuery
 Set the name of the cache region where query results should be cached (assumingSelectionQuery.isCacheable()).null indicates to use the default region.
 Specified by:
 setCacheRegion in interface SelectionQuery<R>
 See Also:
 SelectionQuery.getCacheRegion()
- setCacheMode
 Query<R> setCacheMode(CacheMode cacheMode)
 Description copied from interface: SelectionQuery
 Set the currentCacheMode in effect for this query.
 Set it tonull to indicate that theCacheMode of thesession should be used.
 Specified by:
 setCacheMode in interface SelectionQuery<R>
 See Also:
 SelectionQuery.getCacheMode()
 Session.setCacheMode(CacheMode)
- setCacheStoreMode
 Query<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)
 Specified by:
 setCacheStoreMode in interface Query
 Specified by:
 setCacheStoreMode in interface SelectionQuery<R>
 Specified by:
 setCacheStoreMode in interface TypedQuery<R>
 See Also:
 SelectionQuery.setCacheMode(CacheMode)
- setCacheRetrieveMode
 Query<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
 Specified by:
 setCacheRetrieveMode in interface Query
 Specified by:
 setCacheRetrieveMode in interface SelectionQuery<R>
 Specified by:
 setCacheRetrieveMode in interface TypedQuery<R>
 See Also:
 SelectionQuery.setCacheMode(CacheMode)
- setTimeout
 Query<R> setTimeout(int timeout)
 Description copied from interface: CommonQueryContract
 Set the query timeoutin seconds.
 Any value set here is eventually passed directly along to theJDBC statement, which expressly disallows negative values. So negative values should be avoidedas a general rule, although certain "magic values" are handled - seeTimeouts.NO_WAIT.
 A value of zero indicates no timeout.
 Specified by:
 setTimeout in interface CommonQueryContract
 Specified by:
 setTimeout in interface MutationQuery
 Specified by:
 setTimeout in interface SelectionQuery<R>
 Parameters:
 timeout - the timeoutin seconds
 Returns:
 this, for method chaining
 See Also:
 Timeouts
 CommonQueryContract.setTimeout(Timeout)
 CommonQueryContract.getTimeout()
- setFetchSize
 Query<R> setFetchSize(int fetchSize)
 Description copied from interface: SelectionQuery
 Sets a JDBC fetch size hint for the query.
 Specified by:
 setFetchSize in interface SelectionQuery<R>
 Parameters:
 fetchSize - the fetch size hint
 Returns:
 this, for method chaining
 See Also:
 SelectionQuery.getFetchSize()
- setReadOnly
 Query<R> setReadOnly(boolean readOnly)
 Description copied from interface: SelectionQuery
 Set the read-only/modifiable mode for entities and proxies loaded by thisQuery. This setting overrides the default setting for the persistence context,Session.isDefaultReadOnly().
 To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session, useSession.setDefaultReadOnly(boolean).
 Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted.
 When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting.
 The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session beforeQuery the query was executed.
 Specified by:
 setReadOnly in interface SelectionQuery<R>
 Parameters:
 readOnly -true indicates that entities and proxies loaded by the query are to be put in read-only mode;false indicates that entities and proxies loaded by the query will be put in modifiable mode
 Returns:
 this, for method chaining
- setMaxResults
 Query<R> setMaxResults(int maxResults)
 Description copied from interface: SelectionQuery
 Set the maximum number of query result rows to return.
 Specified by:
 setMaxResults in interface Query
 Specified by:
 setMaxResults in interface SelectionQuery<R>
 Specified by:
 setMaxResults in interface TypedQuery<R>
 Parameters:
 maxResults - the maximum length of the query result list
- setFirstResult
 Query<R> setFirstResult(int startPosition)
 Description copied from interface: SelectionQuery
 Set the first query result row to return. The very first row of the query result list is considered the zeroth row.
 Specified by:
 setFirstResult in interface Query
 Specified by:
 setFirstResult in interface SelectionQuery<R>
 Specified by:
 setFirstResult in interface TypedQuery<R>
 Parameters:
 startPosition - the position of the first row to return, indexed from zero
- setPage
 @Incubatingdefault Query<R> setPage(Page page)
 Description copied from interface: SelectionQuery
 Set thepage of results to return.
 Specified by:
 setPage in interface SelectionQuery<R>
 See Also:
 Page
- setHint
 Query<R> setHint(String hintName,Object value)
 Description copied from interface: CommonQueryContract
 Set a hint. The hints understood by Hibernate are enumerated byAvailableHints.
 Specified by:
 setHint in interface CommonQueryContract
 Specified by:
 setHint in interface MutationQuery
 Specified by:
 setHint in interface Query
 Specified by:
 setHint in interface SelectionQuery<R>
 Specified by:
 setHint in interface TypedQuery<R>
 See Also:
 HibernateHints
 SpecHints
- setEntityGraph
 Query<R> setEntityGraph(EntityGraph<? superR> graph,GraphSemantic semantic)
 Description copied from interface: SelectionQuery
 Apply anEntityGraph to the query.
 This is an alternative way to specify the associations which should be fetched as part of the initial query.
 Specified by:
 setEntityGraph in interface SelectionQuery<R>
- enableFetchProfile
 Query<R> enableFetchProfile(String profileName)
 Description copied from interface: SelectionQuery
 Enable thefetch profile with the given name during execution of this query. If the requested fetch profile is already enabled, the call has no effect.
 This is an alternative way to specify the associations which should be fetched as part of the initial query.
 Specified by:
 enableFetchProfile in interface SelectionQuery<R>
 Parameters:
 profileName - the name of the fetch profile to be enabled
 See Also:
 FetchProfile
- disableFetchProfile
 Query<R> disableFetchProfile(String profileName)
 Description copied from interface: SelectionQuery
 Disable thefetch profile with the given name in this session. If the fetch profile is not currently enabled, the call has no effect.
 Specified by:
 disableFetchProfile in interface SelectionQuery<R>
 Parameters:
 profileName - the name of the fetch profile to be disabled
 See Also:
 FetchProfile
- setFlushMode
 @Deprecated(since="7")Query<R> setFlushMode(FlushModeType flushMode)
 Deprecated.
 Description copied from interface: CommonQueryContract
 Set theFlushMode to use for this query.
 Setting this tonull ultimately indicates to use theFlushMode of the session. UseCommonQueryContract.setHibernateFlushMode(org.hibernate.FlushMode) passingFlushMode.MANUAL instead to indicate that no automatic flushing should occur.
 Specified by:
 setFlushMode in interface CommonQueryContract
 Specified by:
 setFlushMode in interface MutationQuery
 Specified by:
 setFlushMode in interface Query
 Specified by:
 setFlushMode in interface SelectionQuery<R>
 Specified by:
 setFlushMode in interface TypedQuery<R>
 See Also:
 CommonQueryContract.getQueryFlushMode()
 CommonQueryContract.getHibernateFlushMode()
 Session.getHibernateFlushMode()
- setLockMode
 Query<R> setLockMode(LockModeType lockMode)
 Description copied from interface: SelectionQuery
 Specify the rootLockModeType for the query
 Specified by:
 setLockMode in interface Query
 Specified by:
 setLockMode in interface SelectionQuery<R>
 Specified by:
 setLockMode in interface TypedQuery<R>
 See Also:
 SelectionQuery.setHibernateLockMode(org.hibernate.LockMode)
- setResultTransformer
 @Deprecated(since="5.2")default <T> Query<T> setResultTransformer(ResultTransformer<T> transformer)
 Deprecated.
 UsesetTupleTransformer(org.hibernate.query.TupleTransformer<T>) orsetResultListTransformer(org.hibernate.query.ResultListTransformer<R>)

Movatterモバイル変換

Interface Query<R>

Method Summary

Methods inherited from interface org.hibernate.query.CommonQueryContract

Methods inherited from interface jakarta.persistence.Query

Methods inherited from interface org.hibernate.query.SelectionQuery

Methods inherited from interface jakarta.persistence.TypedQuery

Method Details

list

getResultList

scroll

scroll

getResultStream

stream

uniqueResult

getSingleResult

uniqueResultOptional

executeUpdate

getSession

getQueryString

applyGraph

applyFetchGraph

applyLoadGraph

getComment

setComment

addQueryHint

getLockOptions

setLockOptions

setLockMode

setTimeout

setLockScope

setTupleTransformer

setResultListTransformer

getQueryOptions

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setProperties

setProperties

setHibernateFlushMode

setQueryFlushMode

setCacheable

setCacheRegion

setCacheMode

setCacheStoreMode

setCacheRetrieveMode

setTimeout