Package org.hibernate.query
Interface Query<R>
-
- All Superinterfaces:
BasicQueryContract<CommonQueryContract>
,CommonQueryContract
,Query
,Query<R>
,TypedQuery<R>
- All Known Subinterfaces:
NativeQuery<T>
,NativeQueryImplementor<T>
,ProcedureCallImplementor<R>
,QueryImplementor<R>
public interface Query<R> extends TypedQuery<R>, Query<R>, CommonQueryContract
Represents an HQL/JPQL query or a compiled Criteria query. Also acts as the Hibernate extension to the JPA Query/TypedQuery contract NOTE:Query
is deprecated, and slated for removal in 6.0. For the time being we leave all methods defined onQuery
rather than here because it was previously the public API so we want to leave that unchanged in 5.x. For 6.0 we will move those methods here and then delete that class.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description Query<R>
addQueryHint(String hint)
Add a DB query hint to the SQL.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 semanticsCacheMode
getCacheMode()
Obtain the CacheMode in effect for this query.String
getCacheRegion()
Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion onQuery.isCacheable()
for more information).String
getComment()
Obtain the comment currently associated with this query.Integer
getFetchSize()
Obtain the JDBC fetch size hint in effect for this query.FlushMode
getHibernateFlushMode()
Obtain the FlushMode in effect for this query.LockOptions
getLockOptions()
Obtains the LockOptions in effect for this query.ParameterMetadata
getParameterMetadata()
Access to information about query parameters.QueryProducer
getProducer()
Get the QueryProducer this Query originates from.String
getQueryString()
Get the query string.default List<R>
getResultList()
default Stream<R>
getResultStream()
default R
getSingleResult()
List<R>
list()
Return the query results as a List.ScrollableResults
scroll()
Return the query results as ScrollableResults.ScrollableResults
scroll(ScrollMode scrollMode)
Return the query results as ScrollableResults.default Query<R>
setBigDecimal(int position, BigDecimal val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setBigDecimal(String name, BigDecimal val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setBigInteger(int position, BigInteger val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setBigInteger(String name, BigInteger val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setBinary(int position, byte[] val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setBinary(String name, byte[] val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setBoolean(int position, boolean val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setBoolean(String name, boolean val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setByte(int position, byte val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setByte(String name, byte val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadQuery<R>
setCacheable(boolean cacheable)
Enable/disable second level query (result) caching for this query.Query<R>
setCacheMode(CacheMode cacheMode)
(Re)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 (if cached at all).default Query<R>
setCalendar(int position, Calendar val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setCalendar(String name, Calendar value)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setCalendarDate(int position, Calendar val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setCalendarDate(String name, Calendar value)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setCharacter(int position, char val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setCharacter(String name, char val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadQuery<R>
setComment(String comment)
Set the comment for this query.default Query<R>
setDate(int position, Date val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setDate(String name, Date val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setDouble(int position, double val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setDouble(String name, double val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadQuery<R>
setEntity(int position, Object val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadQuery<R>
setEntity(String name, Object val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadQuery<R>
setFetchSize(int fetchSize)
Sets a JDBC fetch size hint for the query.Query<R>
setFirstResult(int startPosition)
default Query<R>
setFloat(int position, float val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setFloat(String name, float val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadQuery<R>
setFlushMode(FlushModeType flushMode)
default Query<R>
setFlushMode(FlushMode flushMode)
Deprecated.(since 5.2) usesetHibernateFlushMode(org.hibernate.FlushMode)
insteadQuery<R>
setHibernateFlushMode(FlushMode flushMode)
(Re)set the current FlushMode in effect for this query.Query<R>
setHint(String hintName, Object value)
default Query<R>
setInteger(int position, int val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setInteger(String name, int val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setLocale(int position, Locale val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setLocale(String name, Locale val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadQuery<R>
setLockMode(String alias, LockMode lockMode)
Set the LockMode to use for specific alias (as defined in the query's FROM clause).Query<R>
setLockMode(LockModeType lockMode)
Query<R>
setLockOptions(LockOptions lockOptions)
Set the lock options for the query.default Query<R>
setLong(int position, long val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setLong(String name, long val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadQuery<R>
setMaxResults(int maxResult)
Query<R>
setParameter(int position, Object value)
Bind a positional query parameter using its inferred Type.Query<R>
setParameter(int position, Object val, Type type)
Bind a value to a JDBC-style query parameter.Query<R>
setParameter(int position, Instant value, TemporalType temporalType)
Query<R>
setParameter(int position, LocalDateTime value, TemporalType temporalType)
Query<R>
setParameter(int position, OffsetDateTime value, TemporalType temporalType)
Query<R>
setParameter(int position, ZonedDateTime value, TemporalType temporalType)
Query<R>
setParameter(int position, Calendar value, TemporalType temporalType)
Query<R>
setParameter(int position, Date value, TemporalType temporalType)
<P> Query<R>
setParameter(int position, P val, TemporalType temporalType)
Bind a positional query parameter as some form of date/time using the indicated temporal-type.Query<R>
setParameter(String name, Object value)
Bind a named query parameter using its inferred Type.Query<R>
setParameter(String name, Object val, Type type)
Bind a named query parameter using the supplied TypeQuery<R>
setParameter(String name, Instant value, TemporalType temporalType)
Query<R>
setParameter(String name, LocalDateTime value, TemporalType temporalType)
Query<R>
setParameter(String name, OffsetDateTime value, TemporalType temporalType)
Query<R>
setParameter(String name, ZonedDateTime value, TemporalType temporalType)
Query<R>
setParameter(String name, Calendar value, TemporalType temporalType)
Query<R>
setParameter(String name, Date value, TemporalType temporalType)
<P> Query<R>
setParameter(String name, P val, TemporalType temporalType)
Bind a named query parameter as some form of date/time using the indicated temporal-type.Query<R>
setParameter(Parameter<Instant> param, Instant value, TemporalType temporalType)
Query<R>
setParameter(Parameter<LocalDateTime> param, LocalDateTime value, TemporalType temporalType)
Query<R>
setParameter(Parameter<OffsetDateTime> param, OffsetDateTime value, TemporalType temporalType)
Query<R>
setParameter(Parameter<ZonedDateTime> param, ZonedDateTime value, TemporalType temporalType)
Query<R>
setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)
Query<R>
setParameter(Parameter<Date> param, Date value, TemporalType temporalType)
<T> Query<R>
setParameter(Parameter<T> param, T value)
<P> Query<R>
setParameter(QueryParameter<P> parameter, P val, TemporalType temporalType)
Bind a query parameter as some form of date/time using the indicated temporal-type.<P> Query<R>
setParameter(QueryParameter<P> parameter, P val, Type type)
Bind a query parameter using the supplied Type<T> Query<R>
setParameter(QueryParameter<T> parameter, T val)
Bind a query parameter using its inferred Type.Query<R>
setParameterList(String name, Object[] values)
Bind multiple values to a named query parameter.Query<R>
setParameterList(String name, Object[] values, Type type)
Bind multiple values to a named query parameter.Query<R>
setParameterList(String name, Collection values)
Bind multiple values to a named query parameter.Query<R>
setParameterList(String name, Collection values, Type type)
Bind multiple values to a named query parameter.<P> Query<R>
setParameterList(QueryParameter<P> parameter, Collection<P> values)
Bind multiple values to a query parameter using its inferred Type.default Query<R>
setParameters(Object[] values, Type[] types)
Deprecated.(since 5.2) Bind values individuallyQuery<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>
setResultTransformer(ResultTransformer transformer)
Deprecated.(since 5.2)default Query<R>
setSerializable(int position, Serializable val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setSerializable(String name, Serializable val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setShort(int position, short val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setShort(String name, short val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setString(int position, String val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setString(String name, String val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setText(int position, String val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setText(String name, String val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteaddefault Query<R>
setTime(int position, Date val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setTime(String name, Date val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadQuery<R>
setTimeout(int timeout)
Set the query timeout in seconds.default Query<R>
setTimestamp(int position, Date val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteaddefault Query<R>
setTimestamp(String name, Date value)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadStream<R>
stream()
Retrieve a Stream over the query results.R
uniqueResult()
Convenience method to return a single instance that matches the query, ornull
if the query returns no results.Optional<R>
uniqueResultOptional()
-
Methods inherited from interface javax.persistence.Query
executeUpdate, getFirstResult, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap
-
Methods inherited from interface org.hibernate.Query
determineProperBooleanType, determineProperBooleanType, getFlushMode, getHibernateFirstResult, getHibernateMaxResults, getNamedParameters, getQueryOptions, getReturnAliases, getReturnTypes, getTimeout, isCacheable, isReadOnly, iterate, setHibernateFirstResult, setHibernateMaxResults, setParameterList, setParameterList, setParameterList, setParameterList
-
-
-
-
Method Detail
-
getProducer
QueryProducer getProducer()
Get the QueryProducer this Query originates from.
-
stream
Stream<R> stream()
Retrieve a Stream over the query results. In the initial implementation (5.2) this returns a simple sequential Stream. The plan is to return a smarter stream in 6.x leveraging the SQM model.You should call
BaseStream.close()
after processing the stream so that the underlying resources are deallocated right away.- Returns:
- The results Stream
- Since:
- 5.2
-
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- ApiNote:
- This method calls
applyGraph(RootGraph, GraphSemantic)
usingGraphSemantic.FETCH
as the semantic
-
applyLoadGraph
default Query<R> applyLoadGraph(RootGraph graph)
Apply the given graph using load semantics- ApiNote:
- This method calls
applyGraph(RootGraph, GraphSemantic)
usingGraphSemantic.LOAD
as the semantic
-
setParameter
Query<R> setParameter(Parameter<Instant> param, Instant value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(Parameter<LocalDateTime> param, LocalDateTime value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(Parameter<ZonedDateTime> param, ZonedDateTime value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(Parameter<OffsetDateTime> param, OffsetDateTime value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(String name, Instant value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(String name, LocalDateTime value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(String name, ZonedDateTime value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(String name, OffsetDateTime value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(int position, Instant value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(int position, LocalDateTime value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(int position, ZonedDateTime value, TemporalType temporalType)
-
setParameter
Query<R> setParameter(int position, OffsetDateTime value, TemporalType temporalType)
-
scroll
ScrollableResults scroll()
Description copied from interface:Query
Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.You should call
ScrollableResults.close()
after processing the ScrollableResults so that the underlying resources are deallocated right away.- Specified by:
scroll
in interfaceQuery<R>
- Returns:
- the result iterator
- See Also:
ScrollableResults
-
scroll
ScrollableResults scroll(ScrollMode scrollMode)
Description copied from interface:Query
Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.You should call
ScrollableResults.close()
after processing the ScrollableResults so that the underlying resources are deallocated right away.- Specified by:
scroll
in interfaceQuery<R>
- Parameters:
scrollMode
- The scroll mode- Returns:
- the result iterator
- See Also:
ScrollableResults
,ScrollMode
-
list
List<R> list()
Description copied from interface:Query
Return the query results as a List. If the query contains multiple results per row, the results are returned in an instance of Object[].
-
getResultList
default List<R> getResultList()
- Specified by:
getResultList
in interfaceQuery
- Specified by:
getResultList
in interfaceTypedQuery<R>
-
uniqueResult
R uniqueResult()
Description copied from interface:Query
Convenience method to return a single instance that matches the query, ornull
if the query returns no results.- Specified by:
uniqueResult
in interfaceQuery<R>
- Returns:
- the single result or null
-
getSingleResult
default R getSingleResult()
- Specified by:
getSingleResult
in interfaceQuery
- Specified by:
getSingleResult
in interfaceTypedQuery<R>
-
getHibernateFlushMode
FlushMode getHibernateFlushMode()
Description copied from interface:Query
Obtain the FlushMode in effect for this query. By default, the query inherits the FlushMode of the Session from which it originates.- Specified by:
getHibernateFlushMode
in interfaceBasicQueryContract<R>
- Specified by:
getHibernateFlushMode
in interfaceQuery<R>
- Returns:
- The query FlushMode.
- See Also:
FlushMode
-
getCacheMode
CacheMode getCacheMode()
Description copied from interface:Query
Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the Session from which is originates. NOTE: The CacheMode here only effects reading/writing of the query cache, not the entity/collection caches.- Specified by:
getCacheMode
in interfaceBasicQueryContract<R>
- Specified by:
getCacheMode
in interfaceQuery<R>
- Returns:
- The query CacheMode.
- See Also:
Session.getCacheMode()
,CacheMode
-
getCacheRegion
String getCacheRegion()
Description copied from interface:Query
Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion onQuery.isCacheable()
for more information).null
indicates that the default region should be used.- Specified by:
getCacheRegion
in interfaceBasicQueryContract<R>
- Specified by:
getCacheRegion
in interfaceQuery<R>
- Returns:
- The specified cache region name into which query results should be placed;
null
indicates the default region.
-
getFetchSize
Integer getFetchSize()
Description copied from interface:Query
Obtain the JDBC fetch size hint in effect for this query. This value is eventually passed along to the JDBC query viaStatement.setFetchSize(int)
. As defined b y JDBC, this value is a hint to the driver to indicate how many rows to fetch from the database when more rows are needed. NOTE : JDBC expressly defines this value as a hint. It may or may not have any effect on the actual query execution and ResultSet processing depending on the driver.- Specified by:
getFetchSize
in interfaceBasicQueryContract<R>
- Specified by:
getFetchSize
in interfaceQuery<R>
- Returns:
- The timeout in seconds
- See Also:
Statement.getFetchSize()
,Statement.setFetchSize(int)
-
getLockOptions
LockOptions getLockOptions()
Description copied from interface:Query
Obtains the LockOptions in effect for this query.- Specified by:
getLockOptions
in interfaceQuery<R>
- Returns:
- The LockOptions
- See Also:
LockOptions
-
getComment
String getComment()
Description copied from interface:Query
Obtain the comment currently associated with this query. Provided SQL commenting is enabled (generally by enabling thehibernate.use_sql_comments
config setting), this comment will also be added to the SQL query sent to the database. Often useful for identifying the source of troublesome queries on the database side.- Specified by:
getComment
in interfaceQuery<R>
- Returns:
- The comment.
-
getQueryString
String getQueryString()
Description copied from interface:Query
Get the query string.- Specified by:
getQueryString
in interfaceQuery<R>
- Returns:
- the query string
-
getParameterMetadata
ParameterMetadata getParameterMetadata()
Description copied from interface:Query
Access to information about query parameters.- Specified by:
getParameterMetadata
in interfaceQuery<R>
- Returns:
- information about query parameters.
-
setMaxResults
Query<R> setMaxResults(int maxResult)
- Specified by:
setMaxResults
in interfaceQuery
- Specified by:
setMaxResults
in interfaceQuery<R>
- Specified by:
setMaxResults
in interfaceTypedQuery<R>
-
setFirstResult
Query<R> setFirstResult(int startPosition)
- Specified by:
setFirstResult
in interfaceQuery
- Specified by:
setFirstResult
in interfaceQuery<R>
- Specified by:
setFirstResult
in interfaceTypedQuery<R>
-
setParameter
<T> Query<R> setParameter(Parameter<T> param, T value)
- Specified by:
setParameter
in interfaceQuery
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceTypedQuery<R>
-
setParameter
Query<R> setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)
- Specified by:
setParameter
in interfaceQuery
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceTypedQuery<R>
-
setParameter
Query<R> setParameter(Parameter<Date> param, Date value, TemporalType temporalType)
- Specified by:
setParameter
in interfaceQuery
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceTypedQuery<R>
-
setParameter
Query<R> setParameter(String name, Object value)
Description copied from interface:Query
Bind a named query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, andQuery.setParameter(String, Object, Type)
should be used instead- Specified by:
setParameter
in interfaceQuery
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceTypedQuery<R>
- Parameters:
name
- the parameter namevalue
- the (possibly-null) parameter value- Returns:
this
, for method chaining
-
setParameter
Query<R> setParameter(String name, Object val, Type type)
Description copied from interface:Query
Bind a named query parameter using the supplied Type- Specified by:
setParameter
in interfaceQuery<R>
- Parameters:
name
- the name of the parameterval
- the possibly-null parameter valuetype
- the Hibernate type- Returns:
this
, for method chaining
-
setParameter
Query<R> setParameter(String name, Calendar value, TemporalType temporalType)
- Specified by:
setParameter
in interfaceQuery
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceTypedQuery<R>
-
setParameter
Query<R> setParameter(String name, Date value, TemporalType temporalType)
- Specified by:
setParameter
in interfaceQuery
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceTypedQuery<R>
-
setParameter
Query<R> setParameter(int position, Object value)
Description copied from interface:Query
Bind a positional query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, andQuery.setParameter(int, Object, Type)
should be used instead- Specified by:
setParameter
in interfaceQuery
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceTypedQuery<R>
- Parameters:
position
- the position of the parameter in the query string, numbered from 0.value
- the possibly-null parameter value- Returns:
this
, for method chaining
-
setParameter
Query<R> setParameter(int position, Calendar value, TemporalType temporalType)
- Specified by:
setParameter
in interfaceQuery
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceTypedQuery<R>
-
setParameter
Query<R> setParameter(int position, Date value, TemporalType temporalType)
- Specified by:
setParameter
in interfaceQuery
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceTypedQuery<R>
-
setParameter
<T> Query<R> setParameter(QueryParameter<T> parameter, T val)
Description copied from interface:Query
Bind a query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, andQuery.setParameter(QueryParameter, Object, Type)
should be used instead- Specified by:
setParameter
in interfaceQuery<R>
- Parameters:
parameter
- The query parameter mementoval
- the possibly-null parameter value- Returns:
this
, for method chaining
-
setParameter
<P> Query<R> setParameter(int position, P val, TemporalType temporalType)
Description copied from interface:Query
Bind a positional query parameter as some form of date/time using the indicated temporal-type.- Specified by:
setParameter
in interfaceQuery<R>
- Parameters:
position
- the position of the parameter in the query string, numbered from 0.val
- the possibly-null parameter valuetemporalType
- the temporal-type to use in binding the date/time- Returns:
this
, for method chaining
-
setParameter
<P> Query<R> setParameter(QueryParameter<P> parameter, P val, Type type)
Description copied from interface:Query
Bind a query parameter using the supplied Type- Specified by:
setParameter
in interfaceQuery<R>
- Parameters:
parameter
- The query parameter mementoval
- the possibly-null parameter valuetype
- the Hibernate type- Returns:
this
, for method chaining
-
setParameter
Query<R> setParameter(int position, Object val, Type type)
Description copied from interface:Query
Bind a value to a JDBC-style query parameter.- Specified by:
setParameter
in interfaceQuery<R>
- Parameters:
position
- the position of the parameter in the query string, numbered from 0.val
- the possibly-null parameter valuetype
- the Hibernate type- Returns:
this
, for method chaining
-
setParameter
<P> Query<R> setParameter(QueryParameter<P> parameter, P val, TemporalType temporalType)
Description copied from interface:Query
Bind a query parameter as some form of date/time using the indicated temporal-type.- Specified by:
setParameter
in interfaceQuery<R>
- Parameters:
parameter
- The query parameter mementoval
- the possibly-null parameter valuetemporalType
- the temporal-type to use in binding the date/time- Returns:
this
, for method chaining
-
setParameter
<P> Query<R> setParameter(String name, P val, TemporalType temporalType)
Description copied from interface:Query
Bind a named query parameter as some form of date/time using the indicated temporal-type.- Specified by:
setParameter
in interfaceQuery<R>
- Parameters:
name
- the parameter nameval
- the possibly-null parameter valuetemporalType
- the temporal-type to use in binding the date/time- Returns:
this
, for method chaining
-
setFlushMode
Query<R> setFlushMode(FlushModeType flushMode)
- Specified by:
setFlushMode
in interfaceQuery
- Specified by:
setFlushMode
in interfaceQuery<R>
- Specified by:
setFlushMode
in interfaceTypedQuery<R>
-
setLockMode
Query<R> setLockMode(LockModeType lockMode)
- Specified by:
setLockMode
in interfaceQuery
- Specified by:
setLockMode
in interfaceQuery<R>
- Specified by:
setLockMode
in interfaceTypedQuery<R>
-
setReadOnly
Query<R> setReadOnly(boolean readOnly)
Description copied from interface:Query
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 interfaceBasicQueryContract<R>
- Specified by:
setReadOnly
in interfaceQuery<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 before the query was executed.
-
setHibernateFlushMode
Query<R> setHibernateFlushMode(FlushMode flushMode)
Description copied from interface:Query
(Re)set the current FlushMode in effect for this query.- Specified by:
setHibernateFlushMode
in interfaceBasicQueryContract<R>
- Specified by:
setHibernateFlushMode
in interfaceQuery<R>
- Parameters:
flushMode
- The new FlushMode to use.- Returns:
this
, for method chaining- See Also:
Query.getHibernateFlushMode()
-
setCacheMode
Query<R> setCacheMode(CacheMode cacheMode)
Description copied from interface:Query
(Re)set the current CacheMode in effect for this query.- Specified by:
setCacheMode
in interfaceBasicQueryContract<R>
- Specified by:
setCacheMode
in interfaceQuery<R>
- Parameters:
cacheMode
- The new CacheMode to use.- Returns:
this
, for method chaining- See Also:
Query.getCacheMode()
-
setCacheable
Query<R> setCacheable(boolean cacheable)
Description copied from interface:Query
Enable/disable second level query (result) caching for this query.- Specified by:
setCacheable
in interfaceBasicQueryContract<R>
- Specified by:
setCacheable
in interfaceQuery<R>
- Parameters:
cacheable
- Should the query results be cacheable?- Returns:
this
, for method chaining- See Also:
Query.isCacheable()
-
setCacheRegion
Query<R> setCacheRegion(String cacheRegion)
Description copied from interface:Query
Set the name of the cache region where query results should be cached (if cached at all).- Specified by:
setCacheRegion
in interfaceBasicQueryContract<R>
- Specified by:
setCacheRegion
in interfaceQuery<R>
- Parameters:
cacheRegion
- the name of a query cache region, ornull
to indicate that the default region should be used.- Returns:
this
, for method chaining- See Also:
Query.getCacheRegion()
-
setTimeout
Query<R> setTimeout(int timeout)
Description copied from interface:Query
Set the query timeout in seconds. NOTE it is important to understand that any value set here is eventually passed directly through to the JDBC Statement which expressly disallows negative values. So negative values should be avoided as a general rule.- Specified by:
setTimeout
in interfaceBasicQueryContract<R>
- Specified by:
setTimeout
in interfaceQuery<R>
- Parameters:
timeout
- the timeout in seconds- Returns:
this
, for method chaining- See Also:
Query.getTimeout()
-
setFetchSize
Query<R> setFetchSize(int fetchSize)
Description copied from interface:Query
Sets a JDBC fetch size hint for the query.- Specified by:
setFetchSize
in interfaceBasicQueryContract<R>
- Specified by:
setFetchSize
in interfaceQuery<R>
- Parameters:
fetchSize
- the fetch size hint- Returns:
this
, for method chaining- See Also:
Query.getFetchSize()
-
setLockOptions
Query<R> setLockOptions(LockOptions lockOptions)
Description copied from interface:Query
Set the lock options for the query. Specifically only the following are taken into consideration: For alias-specific locking, useQuery.setLockMode(String, LockMode)
.- Specified by:
setLockOptions
in interfaceQuery<R>
- Parameters:
lockOptions
- The lock options to apply to the query.- Returns:
this
, for method chaining- See Also:
Query.getLockOptions()
-
setLockMode
Query<R> setLockMode(String alias, LockMode lockMode)
Description copied from interface:Query
Set the LockMode to use for specific alias (as defined in the query's FROM clause). The alias-specific lock modes specified here are added to the query's internalLockOptions
. The effect of these alias-specific LockModes is somewhat dependent on the driver/database in use. Generally speaking, for maximum portability, this method should only be used to mark that the rows corresponding to the given alias should be included in pessimistic locking (LockMode.PESSIMISTIC_WRITE
).- Specified by:
setLockMode
in interfaceQuery<R>
- Parameters:
alias
- a query alias, or"this"
for a collection filterlockMode
- The lock mode to apply.- Returns:
this
, for method chaining- See Also:
Query.getLockOptions()
-
setComment
Query<R> setComment(String comment)
Description copied from interface:Query
Set the comment for this query.- Specified by:
setComment
in interfaceQuery<R>
- Parameters:
comment
- The human-readable comment- Returns:
this
, for method chaining- See Also:
Query.getComment()
-
addQueryHint
Query<R> addQueryHint(String hint)
Description copied from interface:Query
Add a DB query hint to the SQL. These differ from JPA'sQueryHint
, which is specific to the JPA implementation and ignores DB vendor-specific hints. Instead, these are intended solely for the vendor-specific hints, such as Oracle's optimizers. Multiple query hints are supported; the Dialect will determine concatenation and placement.- Specified by:
addQueryHint
in interfaceQuery<R>
- Parameters:
hint
- The database specific query hint to add.
-
setParameterList
<P> Query<R> setParameterList(QueryParameter<P> parameter, Collection<P> values)
Description copied from interface:Query
Bind multiple values to a query parameter using its inferred Type. The Hibernate type of the parameter values is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).- Specified by:
setParameterList
in interfaceQuery<R>
- Parameters:
parameter
- the parameter mementovalues
- a collection of values to list- Returns:
this
, for method chaining
-
setParameterList
Query<R> setParameterList(String name, Collection values)
Description copied from interface:Query
Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).- Specified by:
setParameterList
in interfaceQuery<R>
- Parameters:
name
- the name of the parametervalues
- a collection of values to list- Returns:
this
, for method chaining
-
setParameterList
Query<R> setParameterList(String name, Collection values, Type type)
Description copied from interface:Query
Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).- Specified by:
setParameterList
in interfaceQuery<R>
- Parameters:
name
- the name of the parametervalues
- a collection of values to listtype
- the Hibernate type of the values- Returns:
this
, for method chaining
-
setParameterList
Query<R> setParameterList(String name, Object[] values, Type type)
Description copied from interface:Query
Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).- Specified by:
setParameterList
in interfaceQuery<R>
- Parameters:
name
- the name of the parametervalues
- a collection of values to listtype
- the Hibernate type of the values- Returns:
this
, for method chaining
-
setParameterList
Query<R> setParameterList(String name, Object[] values)
Description copied from interface:Query
Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the array. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).- Specified by:
setParameterList
in interfaceQuery<R>
- Parameters:
name
- the name of the parametervalues
- a collection of values to list- Returns:
this
, for method chaining
-
setProperties
Query<R> setProperties(Object bean)
Description copied from interface:Query
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 interfaceQuery<R>
- Parameters:
bean
- any JavaBean or POJO- Returns:
this
, for method chaining
-
setProperties
Query<R> setProperties(Map bean)
Description copied from interface:Query
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 interfaceQuery<R>
- Parameters:
bean
- a java.util.Map- Returns:
this
, for method chaining
-
setFlushMode
@Deprecated default Query<R> setFlushMode(FlushMode flushMode)
Deprecated.(since 5.2) usesetHibernateFlushMode(org.hibernate.FlushMode)
instead(Re)set the current FlushMode in effect for this query.- Specified by:
setFlushMode
in interfaceBasicQueryContract<R>
- Specified by:
setFlushMode
in interfaceQuery<R>
- Parameters:
flushMode
- The new FlushMode to use.- Returns:
this
, for method chaining- See Also:
getHibernateFlushMode()
-
setString
@Deprecated default Query<R> setString(int position, String val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional String-valued parameter.
-
setCharacter
@Deprecated default Query<R> setCharacter(int position, char val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional char-valued parameter.- Specified by:
setCharacter
in interfaceQuery<R>
- Parameters:
position
- The parameter positionval
- The bind value- Returns:
this
, for method chaining
-
setBoolean
@Deprecated default Query<R> setBoolean(int position, boolean val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional boolean-valued parameter.- Specified by:
setBoolean
in interfaceQuery<R>
- Parameters:
position
- The parameter positionval
- The bind value- Returns:
this
, for method chaining
-
setByte
@Deprecated default Query<R> setByte(int position, byte val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional byte-valued parameter.
-
setShort
@Deprecated default Query<R> setShort(int position, short val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional short-valued parameter.
-
setInteger
@Deprecated default Query<R> setInteger(int position, int val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional int-valued parameter.- Specified by:
setInteger
in interfaceQuery<R>
- Parameters:
position
- The parameter positionval
- The bind value- Returns:
this
, for method chaining
-
setLong
@Deprecated default Query<R> setLong(int position, long val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional long-valued parameter.
-
setFloat
@Deprecated default Query<R> setFloat(int position, float val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional float-valued parameter.
-
setDouble
@Deprecated default Query<R> setDouble(int position, double val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional double-valued parameter.
-
setBinary
@Deprecated default Query<R> setBinary(int position, byte[] val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional binary-valued parameter.
-
setText
@Deprecated default Query<R> setText(int position, String val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional String-valued parameter using streaming.
-
setSerializable
@Deprecated default Query<R> setSerializable(int position, Serializable val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional binary-valued parameter using serialization.- Specified by:
setSerializable
in interfaceQuery<R>
- Parameters:
position
- The parameter positionval
- The bind value- Returns:
this
, for method chaining
-
setLocale
@Deprecated default Query<R> setLocale(int position, Locale val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional Locale-valued parameter.
-
setBigDecimal
@Deprecated default Query<R> setBigDecimal(int position, BigDecimal val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional BigDecimal-valued parameter.- Specified by:
setBigDecimal
in interfaceQuery<R>
- Parameters:
position
- The parameter positionval
- The bind value- Returns:
this
, for method chaining
-
setBigInteger
@Deprecated default Query<R> setBigInteger(int position, BigInteger val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional BigDecimal-valued parameter.- Specified by:
setBigInteger
in interfaceQuery<R>
- Parameters:
position
- The parameter positionval
- The bind value- Returns:
this
, for method chaining
-
setDate
@Deprecated default Query<R> setDate(int position, Date val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional Date-valued parameter using just the Date portion.
-
setTime
@Deprecated default Query<R> setTime(int position, Date val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional Date-valued parameter using just the Time portion.
-
setTimestamp
@Deprecated default Query<R> setTimestamp(int position, Date val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional Date-valued parameter using the full Timestamp.- Specified by:
setTimestamp
in interfaceQuery<R>
- Parameters:
position
- The parameter positionval
- The bind value- Returns:
this
, for method chaining
-
setCalendar
@Deprecated default Query<R> setCalendar(int position, Calendar val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional Calendar-valued parameter using the full Timestamp portion.- Specified by:
setCalendar
in interfaceQuery<R>
- Parameters:
position
- The parameter positionval
- The bind value- Returns:
this
, for method chaining
-
setCalendarDate
@Deprecated default Query<R> setCalendarDate(int position, Calendar val)
Deprecated.(since 5.2) usesetParameter(int, Object)
orsetParameter(int, Object, Type)
insteadBind a positional Calendar-valued parameter using just the Date portion.- Specified by:
setCalendarDate
in interfaceQuery<R>
- Parameters:
position
- The parameter positionval
- The bind value- Returns:
this
, for method chaining
-
setString
@Deprecated default Query<R> setString(String name, String val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named String-valued parameter.
-
setCharacter
@Deprecated default Query<R> setCharacter(String name, char val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named char-valued parameter.- Specified by:
setCharacter
in interfaceQuery<R>
- Parameters:
name
- The parameter nameval
- The bind value- Returns:
this
, for method chaining
-
setBoolean
@Deprecated default Query<R> setBoolean(String name, boolean val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named boolean-valued parameter.- Specified by:
setBoolean
in interfaceQuery<R>
- Parameters:
name
- The parameter nameval
- The bind value- Returns:
this
, for method chaining
-
setByte
@Deprecated default Query<R> setByte(String name, byte val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named byte-valued parameter.
-
setShort
@Deprecated default Query<R> setShort(String name, short val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named short-valued parameter.
-
setInteger
@Deprecated default Query<R> setInteger(String name, int val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named int-valued parameter.- Specified by:
setInteger
in interfaceQuery<R>
- Parameters:
name
- The parameter nameval
- The bind value- Returns:
this
, for method chaining
-
setLong
@Deprecated default Query<R> setLong(String name, long val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named long-valued parameter.
-
setFloat
@Deprecated default Query<R> setFloat(String name, float val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named float-valued parameter.
-
setDouble
@Deprecated default Query<R> setDouble(String name, double val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named double-valued parameter.
-
setBinary
@Deprecated default Query<R> setBinary(String name, byte[] val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named binary-valued parameter.
-
setText
@Deprecated default Query<R> setText(String name, String val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named String-valued parameter using streaming.
-
setSerializable
@Deprecated default Query<R> setSerializable(String name, Serializable val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named binary-valued parameter using serialization.- Specified by:
setSerializable
in interfaceQuery<R>
- Parameters:
name
- The parameter nameval
- The bind value- Returns:
this
, for method chaining
-
setLocale
@Deprecated default Query<R> setLocale(String name, Locale val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named Locale-valued parameter.
-
setBigDecimal
@Deprecated default Query<R> setBigDecimal(String name, BigDecimal val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named BigDecimal-valued parameter.- Specified by:
setBigDecimal
in interfaceQuery<R>
- Parameters:
name
- The parameter nameval
- The bind value- Returns:
this
, for method chaining
-
setBigInteger
@Deprecated default Query<R> setBigInteger(String name, BigInteger val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named BigInteger-valued parameter.- Specified by:
setBigInteger
in interfaceQuery<R>
- Parameters:
name
- The parameter nameval
- The bind value- Returns:
this
, for method chaining
-
setDate
@Deprecated default Query<R> setDate(String name, Date val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind the val (time is truncated) of a given Date object to a named query parameter.
-
setTime
@Deprecated default Query<R> setTime(String name, Date val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind the time (val is truncated) of a given Date object to a named query parameter.
-
setTimestamp
@Deprecated default Query<R> setTimestamp(String name, Date value)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind the value and the time of a given Date object to a named query parameter.- Specified by:
setTimestamp
in interfaceQuery<R>
- Parameters:
name
- The name of the parametervalue
- The value object- Returns:
this
, for method chaining
-
setCalendar
@Deprecated default Query<R> setCalendar(String name, Calendar value)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named Calendar-valued parameter using the full Timestamp.- Specified by:
setCalendar
in interfaceQuery<R>
- Parameters:
name
- The parameter namevalue
- The bind value- Returns:
this
, for method chaining
-
setCalendarDate
@Deprecated default Query<R> setCalendarDate(String name, Calendar value)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind a named Calendar-valued parameter using just the Date portion.- Specified by:
setCalendarDate
in interfaceQuery<R>
- Parameters:
name
- The parameter namevalue
- The bind value- Returns:
this
, for method chaining
-
setEntity
@Deprecated Query<R> setEntity(int position, Object val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind an instance of a mapped persistent class to a JDBC-style query parameter. UsesetParameter(int, Object)
for null values.
-
setEntity
@Deprecated Query<R> setEntity(String name, Object val)
Deprecated.(since 5.2) usesetParameter(String, Object)
orsetParameter(String, Object, Type)
insteadBind an instance of a mapped persistent class to a named query parameter. UsesetParameter(String, Object)
for null values.
-
setResultTransformer
@Deprecated Query<R> setResultTransformer(ResultTransformer transformer)
Deprecated.(since 5.2)Set a strategy for handling the query results. This can be used to change "shape" of the query result.- Specified by:
setResultTransformer
in interfaceQuery<R>
- Parameters:
transformer
- The transformer to apply- Returns:
- this (for method chaining)
- Todo:
- develop a new approach to result transformers
-
setParameters
@Deprecated default Query<R> setParameters(Object[] values, Type[] types)
Deprecated.(since 5.2) Bind values individuallyBind values and types to positional parameters. Allows binding more than one at a time; no real performance impact. The number of elements in each array should match. That is, element number-0 in types array corresponds to element-0 in the values array, etc,- Specified by:
setParameters
in interfaceQuery<R>
- Parameters:
types
- The typesvalues
- The values- Returns:
this
, for method chaining
-
getResultStream
default Stream<R> getResultStream()
JPA 2.2 defines thegetResultStream
method so to get aStream
from the JDBCResultSet
. Hibernate 5.2 already defines thestream()
method, sogetResultStream
can delegate to it.- Specified by:
getResultStream
in interfaceQuery
- Specified by:
getResultStream
in interfaceTypedQuery<R>
- Returns:
- The results Stream
- Since:
- 5.2.11
-
-