Interface Query<R>
-
- Type Parameters:
R
- The result type, for typed queries, orObject
for untyped queries
- All Superinterfaces:
CommonQueryContract
,MutationQuery
,jakarta.persistence.Query
,SelectionQuery<R>
,jakarta.persistence.TypedQuery<R>
- All Known Subinterfaces:
NativeQuery<T>
,NativeQueryImplementor<R>
,ProcedureCallImplementor<R>
,QueryImplementor<R>
,SqmQueryImplementor<R>
- All Known Implementing Classes:
AbstractQuery
,NativeQueryImpl
,ProcedureCallImpl
,QuerySqmImpl
public interface Query<R> extends SelectionQuery<R>, MutationQuery, jakarta.persistence.TypedQuery<R>
Represents a criteria query or a query written in HQL. The subtypeNativeQuery
represents a query written in native SQL.This type simply mixes
TypedQuery
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.A
Query
controls how a query is executed, and allows arguments to be bound to its parameters.- Selection queries are usually executed using
getResultList()
orgetSingleResult()
, and mutation queries must be executed usingexecuteUpdate()
. - The methods
setMaxResults(int)
andsetFirstResult(int)
control limits and pagination. - The various overloads of
setParameter(String, Object)
andsetParameter(int, Object)
allow arguments to be bound to named and ordinal parameters defined by the query.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description Query<R>
addQueryHint(String hint)
Add a database query hint to the SQL query.default Query<R>
applyFetchGraph(RootGraph graph)
Apply the given graph using fetch semanticsQuery<R>
applyGraph(RootGraph graph, GraphSemantic semantic)
Apply the given graph using the given semanticdefault Query<R>
applyLoadGraph(RootGraph graph)
Apply the given graph using load semanticsint
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()
Obtains theLockOptions
in effect for this query.ParameterMetadata
getParameterMetadata()
Access to information about query parameters.QueryOptions
getQueryOptions()
Get the execution options for thisQuery
.String
getQueryString()
The query as a string, ornull
in the case of a criteria query.default List<R>
getResultList()
Execute the query and return the query results as aList
.default Stream<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 a scrollable form.ScrollableResults<R>
scroll(ScrollMode scrollMode)
Execute the query and return the results in a scrollable form.Query<R>
setCacheable(boolean cacheable)
Enable/disable second level query (result) caching for this query.Query<R>
setCacheMode(CacheMode cacheMode)
Set the current CacheMode 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>
setComment(String comment)
Set the comment for this query.Query<R>
setFetchSize(int fetchSize)
Sets a JDBC fetch size hint for the query.Query<R>
setFirstResult(int startPosition)
Set the first row position to return from the query results.Query<R>
setFlushMode(jakarta.persistence.FlushModeType flushMode)
Set theFlushMode
in to use for this query.Query<R>
setHibernateFlushMode(FlushMode flushMode)
Set the currentFlushMode
in effect for this query.Query<R>
setHint(String hintName, Object value)
Apply hints to the query.Query<R>
setLockMode(jakarta.persistence.LockModeType lockMode)
Specify the root LockModeType for the queryQuery<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)
Set the lock options for the query.Query<R>
setMaxResults(int maxResult)
Set the max number of rows requested for the query results.Query<R>
setParameter(int parameter, Object argument)
Bind the given argument to an ordinal query parameter.Query<R>
setParameter(int parameter, Instant argument, jakarta.persistence.TemporalType temporalType)
Bind anInstant
value to the ordinal query parameter using just the portion indicated by the givenTemporalType
.Query<R>
setParameter(int parameter, Calendar argument, jakarta.persistence.TemporalType temporalType)
Query
overrideQuery<R>
setParameter(int parameter, Date argument, jakarta.persistence.TemporalType temporalType)
Query
override<P> Query<R>
setParameter(int parameter, P argument, Class<P> type)
Bind the given argument to an ordinal query parameter using the given Class reference to attempt to determine theBindableType
to use.<P> Query<R>
setParameter(int parameter, P argument, BindableType<P> type)
Bind the given argument to an ordinal query parameter using the givenBindableType
.Query<R>
setParameter(jakarta.persistence.Parameter<Calendar> parameter, Calendar argument, jakarta.persistence.TemporalType temporalType)
Query
overrideQuery<R>
setParameter(jakarta.persistence.Parameter<Date> parameter, Date argument, jakarta.persistence.TemporalType temporalType)
Query
override<T> Query<R>
setParameter(jakarta.persistence.Parameter<T> parameter, T argument)
Query
overrideQuery<R>
setParameter(String parameter, Object argument)
Bind the given argument to a named query parameter.Query<R>
setParameter(String parameter, Instant argument, jakarta.persistence.TemporalType temporalType)
Bind anInstant
value to the named query parameter using just the portion indicated by the givenTemporalType
.Query<R>
setParameter(String parameter, Calendar argument, jakarta.persistence.TemporalType temporalType)
Query
overrideQuery<R>
setParameter(String parameter, Date argument, jakarta.persistence.TemporalType temporalType)
Query
override<P> Query<R>
setParameter(String parameter, P argument, Class<P> type)
Bind the given argument to a named query parameter using the given Class reference to attempt to determine theBindableType
to use.<P> Query<R>
setParameter(String parameter, P argument, BindableType<P> type)
Bind the given argument to a named query parameter using the givenBindableType
.<P> Query<R>
setParameter(QueryParameter<P> parameter, P argument, Class<P> type)
Bind an argument to the query parameter represented by the givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use.<P> Query<R>
setParameter(QueryParameter<P> parameter, P argument, BindableType<P> type)
Bind an argument to the query parameter represented by the givenQueryParameter
using the givenBindableType
.<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.<P> Query<R>
setParameterList(int parameter, Collection<? extends P> arguments, Class<P> javaType)
Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine theBindableType
to use.<P> Query<R>
setParameterList(int parameter, Collection<? extends P> arguments, BindableType<P> type)
Bind multiple arguments to an ordinal query parameter using the givenBindableType
.<P> Query<R>
setParameterList(int parameter, P[] arguments, Class<P> javaType)
Bind multiple arguments to an ordinal query parameter using the givenClass
reference to attempt to determine theBindableType
to use.<P> Query<R>
setParameterList(int parameter, P[] arguments, BindableType<P> type)
Bind multiple arguments to an ordinal query parameter using the givenBindableType
.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.<P> Query<R>
setParameterList(String parameter, Collection<? extends P> arguments, Class<P> javaType)
Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theBindableType
to use.<P> Query<R>
setParameterList(String parameter, Collection<? extends P> arguments, BindableType<P> type)
Bind multiple arguments to a named query parameter using the givenBindableType
.<P> Query<R>
setParameterList(String parameter, P[] arguments, Class<P> javaType)
Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theBindableType
to use.<P> Query<R>
setParameterList(String parameter, P[] arguments, BindableType<P> type)
Bind multiple arguments to a named query parameter using the givenBindableType
.<P> Query<R>
setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
.<P> Query<R>
setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments, Class<P> javaType)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use.<P> Query<R>
setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments, BindableType<P> type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
, inferring theBindableType
.<P> Query<R>
setParameterList(QueryParameter<P> parameter, P[] arguments)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
<P> Query<R>
setParameterList(QueryParameter<P> parameter, P[] arguments, Class<P> javaType)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use.<P> Query<R>
setParameterList(QueryParameter<P> parameter, P[] arguments, BindableType<P> type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
, inferring theBindableType
.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 given Map for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.Query<R>
setReadOnly(boolean readOnly)
Set the read-only/modifiable mode for entities and proxies loaded by this Query.Query<R>
setResultListTransformer(ResultListTransformer<R> transformer)
Set aResultListTransformer
default <T> Query<T>
setResultTransformer(ResultTransformer<T> transformer)
Query<R>
setTimeout(int timeout)
Set the query timeout in seconds.<T> Query<T>
setTupleTransformer(TupleTransformer<T> transformer)
Set aTupleTransformer
default Stream<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, getTimeout
-
Methods inherited from interface jakarta.persistence.Query
getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap
-
Methods inherited from interface org.hibernate.query.SelectionQuery
getCacheMode, getCacheRegion, getFetchSize, getFirstResult, getMaxResults, getSingleResultOrNull, isCacheable, isReadOnly, setAliasSpecificLockMode, setFollowOnLocking, setHibernateLockMode
-
-
-
-
Method Detail
-
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 interfaceSelectionQuery<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 interfacejakarta.persistence.Query
- Specified by:
getResultList
in interfaceSelectionQuery<R>
- Specified by:
getResultList
in interfacejakarta.persistence.TypedQuery<R>
- Returns:
- the results as a list
-
scroll
ScrollableResults<R> scroll()
Execute the query and return the results in a scrollable form.This overload simply calls
scroll(ScrollMode)
using the dialect default scroll mode.- Specified by:
scroll
in interfaceSelectionQuery<R>
-
scroll
ScrollableResults<R> scroll(ScrollMode scrollMode)
Execute the query and return the results in a scrollable form. The capabilities of the returnedScrollableResults
depend on the specifiedScrollMode
.- Specified by:
scroll
in interfaceSelectionQuery<R>
-
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 call
BaseStream.close()
after processing the stream so that resources are freed as soon as possible.- Specified by:
getResultStream
in interfacejakarta.persistence.Query
- Specified by:
getResultStream
in interfaceSelectionQuery<R>
- Specified by:
getResultStream
in interfacejakarta.persistence.TypedQuery<R>
- Returns:
- The results as a
Stream
-
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 call
BaseStream.close()
after processing the stream so that resources are freed as soon as possible.- Specified by:
stream
in interfaceSelectionQuery<R>
- Returns:
- The results as a
Stream
- 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 interfaceSelectionQuery<R>
- Returns:
- the single result or
null
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 interfacejakarta.persistence.Query
- Specified by:
getSingleResult
in interfaceSelectionQuery<R>
- Specified by:
getSingleResult
in interfacejakarta.persistence.TypedQuery<R>
- Returns:
- the single result, only if there is exactly one
- Throws:
jakarta.persistence.NonUniqueResultException
- if there is more than one matching resultjakarta.persistence.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 interfaceSelectionQuery<R>
- Returns:
- the single result as an
Optional
- 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 of
MutationQuery
created usingQueryProducer.createMutationQuery(String)
,QueryProducer.createNamedMutationQuery(String)
,QueryProducer.createNativeMutationQuery(String)
,QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaUpdate)
, orQueryProducer.createQuery(jakarta.persistence.criteria.CriteriaDelete)
.- Specified by:
executeUpdate
in interfaceMutationQuery
- Specified by:
executeUpdate
in interfacejakarta.persistence.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)
,Query.executeUpdate()
,QueryProducer.createMutationQuery(java.lang.String)
-
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
Query<R> applyGraph(RootGraph graph, GraphSemantic semantic)
Apply the given graph using the given semantic- Parameters:
graph
- The graph the apply.semantic
- The semantic to use when applying the graph- Returns:
- this - for method chaining
-
applyFetchGraph
default Query<R> applyFetchGraph(RootGraph graph)
Apply the given graph using fetch semantics
-
applyLoadGraph
default Query<R> applyLoadGraph(RootGraph graph)
Apply the given graph using load semantics
-
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 interfaceCommonQueryContract
- 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 interfaceCommonQueryContract
- 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 using
QueryHint
orQuery.getHints()
. These are hints to the JPA provider.Multiple query hints may be specified. The operation
Dialect.getQueryHintString(String, List)
determines how the hint is actually added to the SQL query.- Parameters:
hint
- The database specific query hint to add.
-
getLockOptions
LockOptions getLockOptions()
Obtains theLockOptions
in effect for this query.- Specified by:
getLockOptions
in interfaceSelectionQuery<R>
- Returns:
- The LockOptions
- See Also:
LockOptions
-
setLockOptions
Query<R> setLockOptions(LockOptions lockOptions)
Set the lock options for the query.Only the following options are taken into consideration:
For alias-specific locking, usesetLockMode(String, LockMode)
.- 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 the
LockOption
s.The effect of alias-specific locking is quite dependent on the driver and database. For maximum portability, the given lock mode should be
LockMode.PESSIMISTIC_WRITE
.- Parameters:
alias
- a query alias, or"this"
for a collection filterlockMode
- The lock mode to apply.- Returns:
this
, for method chaining- See Also:
getLockOptions()
-
setTupleTransformer
<T> Query<T> setTupleTransformer(TupleTransformer<T> transformer)
Set aTupleTransformer
-
setResultListTransformer
Query<R> setResultListTransformer(ResultListTransformer<R> transformer)
Set aResultListTransformer
-
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.
-
getParameterMetadata
ParameterMetadata getParameterMetadata()
Access to information about query parameters.- Returns:
- information about query parameters.
-
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 interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
setParameter(String, Object, Class)
,setParameter(String, Object, BindableType)
-
setParameter
<P> Query<R> setParameter(String parameter, P argument, Class<P> type)
Bind the given argument to a named query parameter using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,setParameter(String, Object)
is used.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- See Also:
BindableType.parameterType(Class)
,setParameter(String, Object, BindableType)
-
setParameter
<P> Query<R> setParameter(String parameter, P argument, BindableType<P> type)
Bind the given argument to a named query parameter using the givenBindableType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- See Also:
BindableType.parameterType(java.lang.Class<T>)
-
setParameter
Query<R> setParameter(String parameter, Instant argument, jakarta.persistence.TemporalType temporalType)
Bind anInstant
value to the named query parameter using just the portion indicated by the givenTemporalType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceSelectionQuery<R>
-
setParameter
Query<R> setParameter(String parameter, Calendar argument, jakarta.persistence.TemporalType temporalType)
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(String, Calendar, TemporalType)
-
setParameter
Query<R> setParameter(String parameter, Date argument, jakarta.persistence.TemporalType temporalType)
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.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 interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
setParameter(int, Object, Class)
,setParameter(int, Object, BindableType)
-
setParameter
<P> Query<R> setParameter(int parameter, P argument, Class<P> type)
Bind the given argument to an ordinal query parameter using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,setParameter(int, Object)
is used.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- See Also:
BindableType.parameterType(Class)
,setParameter(int, Object, BindableType)
-
setParameter
<P> Query<R> setParameter(int parameter, P argument, BindableType<P> type)
Bind the given argument to an ordinal query parameter using the givenBindableType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- See Also:
BindableType.parameterType(java.lang.Class<T>)
-
setParameter
Query<R> setParameter(int parameter, Instant argument, jakarta.persistence.TemporalType temporalType)
Bind anInstant
value to the ordinal query parameter using just the portion indicated by the givenTemporalType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceSelectionQuery<R>
-
setParameter
Query<R> setParameter(int parameter, Date argument, jakarta.persistence.TemporalType temporalType)
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(int, Date, TemporalType)
-
setParameter
Query<R> setParameter(int parameter, Calendar argument, jakarta.persistence.TemporalType temporalType)
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.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 interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the query parameter mementoargument
- the argument, which might be null- Returns:
this
, for method chaining- See Also:
setParameter(QueryParameter, Object, BindableType)
-
setParameter
<P> Query<R> setParameter(QueryParameter<P> parameter, P argument, Class<P> type)
Bind an argument to the query parameter represented by the givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,setParameter(QueryParameter, Object)
is used- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the query parameter mementoargument
- the argument, which might be nulltype
- aBindableType
representing the type of the parameter- Returns:
this
, for method chaining- See Also:
BindableType.parameterType(Class)
,setParameter(QueryParameter, Object, BindableType)
-
setParameter
<P> Query<R> setParameter(QueryParameter<P> parameter, P argument, BindableType<P> type)
Bind an argument to the query parameter represented by the givenQueryParameter
using the givenBindableType
.- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the query parameter mementoargument
- the argument, which might be nulltype
- anBindableType
representing the type of the parameter- Returns:
this
, for method chaining
-
setParameter
<T> Query<R> setParameter(jakarta.persistence.Parameter<T> parameter, T argument)
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(Parameter, Object)
-
setParameter
Query<R> setParameter(jakarta.persistence.Parameter<Calendar> parameter, Calendar argument, jakarta.persistence.TemporalType temporalType)
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(Parameter, Calendar, TemporalType)
-
setParameter
Query<R> setParameter(jakarta.persistence.Parameter<Date> parameter, Date argument, jakarta.persistence.TemporalType temporalType)
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
setParameterList(java.lang.String, java.util.Collection, BindableType)
-
setParameterList
<P> Query<R> setParameterList(String parameter, Collection<? extends P> arguments, Class<P> javaType)
Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
BindableType.parameterType(Class)
,setParameterList(java.lang.String, java.util.Collection, BindableType)
-
setParameterList
<P> Query<R> setParameterList(String parameter, Collection<? extends P> arguments, BindableType<P> type)
Bind multiple arguments to a named query parameter using the givenBindableType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining
-
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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining
-
setParameterList
<P> Query<R> setParameterList(String parameter, P[] arguments, Class<P> javaType)
Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
BindableType.parameterType(Class)
,setParameterList(java.lang.String, Object[], BindableType)
-
setParameterList
<P> Query<R> setParameterList(String parameter, P[] arguments, BindableType<P> type)
Bind multiple arguments to a named query parameter using the givenBindableType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining
-
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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining
-
setParameterList
<P> Query<R> setParameterList(int parameter, Collection<? extends P> arguments, Class<P> javaType)
Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
BindableType.parameterType(Class)
,setParameterList(int, Collection, BindableType)
-
setParameterList
<P> Query<R> setParameterList(int parameter, Collection<? extends P> arguments, BindableType<P> type)
Bind multiple arguments to an ordinal query parameter using the givenBindableType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining
-
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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining
-
setParameterList
<P> Query<R> setParameterList(int parameter, P[] arguments, Class<P> javaType)
Bind multiple arguments to an ordinal query parameter using the givenClass
reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
BindableType.parameterType(Class)
,setParameterList(int, Object[], BindableType)
-
setParameterList
<P> Query<R> setParameterList(int parameter, P[] arguments, BindableType<P> type)
Bind multiple arguments to an ordinal query parameter using the givenBindableType
.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining
-
setParameterList
<P> Query<R> setParameterList(QueryParameter<P> 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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the parameter mementoarguments
- a collection of arguments- Returns:
this
, for method chaining
-
setParameterList
<P> Query<R> setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments, Class<P> javaType)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,setParameterList(String, Collection)
is used.- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
BindableType.parameterType(Class)
,setParameterList(QueryParameter, java.util.Collection, BindableType)
-
setParameterList
<P> Query<R> setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments, BindableType<P> type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
, inferring theBindableType
.The "type mapping" for the binding is inferred from the type of the first collection element.
- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining
-
setParameterList
<P> Query<R> setParameterList(QueryParameter<P> 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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Parameters:
parameter
- the parameter mementoarguments
- a collection of arguments- Returns:
this
, for method chaining
-
setParameterList
<P> Query<R> setParameterList(QueryParameter<P> parameter, P[] arguments, Class<P> javaType)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
using the given Class reference to attempt to determine theBindableType
to use. If unable to determine an appropriateBindableType
,setParameterList(String, Collection)
is used- Specified by:
setParameterList
in interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining- See Also:
BindableType.parameterType(Class)
,setParameterList(QueryParameter, Object[], BindableType)
-
setParameterList
<P> Query<R> setParameterList(QueryParameter<P> parameter, P[] arguments, BindableType<P> type)
Bind multiple arguments to the query parameter represented by the givenQueryParameter
, inferring theBindableType
. 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 interfaceCommonQueryContract
- Specified by:
setParameterList
in interfaceMutationQuery
- Specified by:
setParameterList
in interfaceSelectionQuery<R>
- Returns:
this
, for method chaining
-
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 interfaceCommonQueryContract
- Specified by:
setProperties
in interfaceMutationQuery
- Specified by:
setProperties
in interfaceSelectionQuery<R>
- Parameters:
bean
- any JavaBean or POJO- Returns:
this
, for method chaining
-
setProperties
Query<R> setProperties(Map bean)
Bind the values of the given Map 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 interfaceCommonQueryContract
- Specified by:
setProperties
in interfaceMutationQuery
- Specified by:
setProperties
in interfaceSelectionQuery<R>
- Parameters:
bean
- aMap
of names to arguments- Returns:
this
, for method chaining
-
setHibernateFlushMode
Query<R> setHibernateFlushMode(FlushMode flushMode)
Description copied from interface:CommonQueryContract
Set the currentFlushMode
in effect for this query.- Specified by:
setHibernateFlushMode
in interfaceCommonQueryContract
- Specified by:
setHibernateFlushMode
in interfaceMutationQuery
- Specified by:
setHibernateFlushMode
in interfaceSelectionQuery<R>
- See Also:
CommonQueryContract.getHibernateFlushMode()
,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 interfaceSelectionQuery<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 interfaceSelectionQuery<R>
- See Also:
SelectionQuery.getCacheRegion()
-
setCacheMode
Query<R> setCacheMode(CacheMode cacheMode)
Description copied from interface:SelectionQuery
Set the current CacheMode in effect for this query.- Specified by:
setCacheMode
in interfaceSelectionQuery<R>
- See Also:
SelectionQuery.getCacheMode()
,Session.setCacheMode(org.hibernate.CacheMode)
-
setTimeout
Query<R> setTimeout(int timeout)
Description copied from interface:CommonQueryContract
Set the query timeout in seconds.Any value set here is eventually passed directly along to the JDBC statement, which expressly disallows negative values. So negative values should be avoided as a general rule.
A value of zero indicates no timeout.
- Specified by:
setTimeout
in interfaceCommonQueryContract
- Specified by:
setTimeout
in interfaceSelectionQuery<R>
- Parameters:
timeout
- the timeout in seconds- Returns:
this
, for method chaining- See Also:
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 interfaceSelectionQuery<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 this Query. This setting overrides the default setting for the persistence context.- Specified by:
setReadOnly
in interfaceSelectionQuery<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- See Also:
To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session:
,PersistenceContext.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.
-
setMaxResults
Query<R> setMaxResults(int maxResult)
Description copied from interface:SelectionQuery
Set the max number of rows requested for the query results. Applied to the SQL query- Specified by:
setMaxResults
in interfacejakarta.persistence.Query
- Specified by:
setMaxResults
in interfaceSelectionQuery<R>
- Specified by:
setMaxResults
in interfacejakarta.persistence.TypedQuery<R>
-
setFirstResult
Query<R> setFirstResult(int startPosition)
Description copied from interface:SelectionQuery
Set the first row position to return from the query results. Applied to the SQL query- Specified by:
setFirstResult
in interfacejakarta.persistence.Query
- Specified by:
setFirstResult
in interfaceSelectionQuery<R>
- Specified by:
setFirstResult
in interfacejakarta.persistence.TypedQuery<R>
-
setHint
Query<R> setHint(String hintName, Object value)
Description copied from interface:CommonQueryContract
Apply hints to the query.- Specified by:
setHint
in interfaceCommonQueryContract
- Specified by:
setHint
in interfacejakarta.persistence.Query
- Specified by:
setHint
in interfaceSelectionQuery<R>
- Specified by:
setHint
in interfacejakarta.persistence.TypedQuery<R>
-
setFlushMode
Query<R> setFlushMode(jakarta.persistence.FlushModeType flushMode)
Description copied from interface:CommonQueryContract
Set theFlushMode
in to use for this query.- Specified by:
setFlushMode
in interfaceCommonQueryContract
- Specified by:
setFlushMode
in interfacejakarta.persistence.Query
- Specified by:
setFlushMode
in interfaceSelectionQuery<R>
- Specified by:
setFlushMode
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
CommonQueryContract.getHibernateFlushMode()
,Session.getHibernateFlushMode()
-
setLockMode
Query<R> setLockMode(jakarta.persistence.LockModeType lockMode)
Description copied from interface:SelectionQuery
Specify the root LockModeType for the query- Specified by:
setLockMode
in interfacejakarta.persistence.Query
- Specified by:
setLockMode
in interfaceSelectionQuery<R>
- Specified by:
setLockMode
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
SelectionQuery.setHibernateLockMode(org.hibernate.LockMode)
-
setResultTransformer
@Deprecated(since="5.2") default <T> Query<T> setResultTransformer(ResultTransformer<T> transformer)
-
-