Query (Hibernate JavaDocs)

All Superinterfaces:

BasicQueryContract, CommonQueryContract, javax.persistence.Query, javax.persistence.TypedQuery<R>

All Known Subinterfaces:

NativeQuery<T>, NativeQueryImplementor<T>, ProcedureCallImplementor<R>, QueryImplementor<R>

All Known Implementing Classes:

AbstractProducedQuery, CollectionFilterImpl, CriteriaQueryTypeQueryAdapter, NativeQueryImpl, ProcedureCallImpl, QueryImpl
```
public interface Query<R>
extends javax.persistence.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 on Query 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 and Description
`Query<R>`	`addQueryHint(java.lang.String hint)` Add a DB query hint to the SQL.
`CacheMode`	`getCacheMode()` Obtain the CacheMode in effect for this query.
`java.lang.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 on `Query.isCacheable()` for more information).
`java.lang.String`	`getComment()` Obtain the comment currently associated with this query.
`java.lang.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.
`RowSelection`	`getQueryOptions()` "QueryOptions" is a better name, I think, than "RowSelection" -> 6.0
`java.lang.String`	`getQueryString()` Get the query string.
`default java.util.List<R>`	`getResultList()`
`default java.util.stream.Stream<R>`	`getResultStream()` JPA 2.2 defines the `getResultStream` method so to get a `Stream` from the JDBC `ResultSet`.
`default R`	`getSingleResult()`
`java.util.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, java.math.BigDecimal val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setBigDecimal(java.lang.String name, java.math.BigDecimal val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setBigInteger(int position, java.math.BigInteger val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setBigInteger(java.lang.String name, java.math.BigInteger val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setBinary(int position, byte[] val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setBinary(java.lang.String name, byte[] val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setBoolean(int position, boolean val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setBoolean(java.lang.String name, boolean val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setByte(int position, byte val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setByte(java.lang.String name, byte val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`Query<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(java.lang.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, java.util.Calendar val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setCalendar(java.lang.String name, java.util.Calendar value)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setCalendarDate(int position, java.util.Calendar val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setCalendarDate(java.lang.String name, java.util.Calendar value)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setCharacter(int position, char val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setCharacter(java.lang.String name, char val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`Query<R>`	`setComment(java.lang.String comment)` Set the comment for this query.
`default Query<R>`	`setDate(int position, java.util.Date val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setDate(java.lang.String name, java.util.Date val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setDouble(int position, double val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setDouble(java.lang.String name, double val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`Query<R>`	`setEntity(int position, java.lang.Object val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`Query<R>`	`setEntity(java.lang.String name, java.lang.Object val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`Query<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) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setFloat(java.lang.String name, float val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setFlushMode(FlushMode flushMode)` Deprecated. (since 5.2) use `setHibernateFlushMode(org.hibernate.FlushMode)` instead
`Query<R>`	`setFlushMode(javax.persistence.FlushModeType flushMode)`
`Query<R>`	`setHibernateFlushMode(FlushMode flushMode)` (Re)set the current FlushMode in effect for this query.
`Query<R>`	`setHint(java.lang.String hintName, java.lang.Object value)`
`default Query<R>`	`setInteger(int position, int val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setInteger(java.lang.String name, int val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setLocale(int position, java.util.Locale val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setLocale(java.lang.String name, java.util.Locale val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`Query<R>`	`setLockMode(javax.persistence.LockModeType lockMode)`
`Query<R>`	`setLockMode(java.lang.String alias, LockMode lockMode)` Set the LockMode to use for specific alias (as defined in the query's `FROM` clause).
`Query<R>`	`setLockOptions(LockOptions lockOptions)` Set the lock options for the query.
`default Query<R>`	`setLong(int position, long val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setLong(java.lang.String name, long val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`Query<R>`	`setMaxResults(int maxResult)`
`Query<R>`	`setParameter(int position, java.util.Calendar value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(int position, java.util.Date value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(int position, java.time.Instant value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(int position, java.time.LocalDateTime value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(int position, java.lang.Object value)` Bind a positional query parameter using its inferred Type.
`Query<R>`	`setParameter(int position, java.lang.Object val, Type type)` Bind a value to a JDBC-style query parameter.
`Query<R>`	`setParameter(int position, java.time.OffsetDateTime value, javax.persistence.TemporalType temporalType)`
`<P> Query<R>`	`setParameter(int position, P val, javax.persistence.TemporalType temporalType)` Bind a positional query parameter as some form of date/time using the indicated temporal-type.
`Query<R>`	`setParameter(int position, java.time.ZonedDateTime value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(javax.persistence.Parameter<java.util.Calendar> param, java.util.Calendar value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(javax.persistence.Parameter<java.util.Date> param, java.util.Date value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(javax.persistence.Parameter<java.time.Instant> param, java.time.Instant value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(javax.persistence.Parameter<java.time.LocalDateTime> param, java.time.LocalDateTime value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(javax.persistence.Parameter<java.time.OffsetDateTime> param, java.time.OffsetDateTime value, javax.persistence.TemporalType temporalType)`
`<T> Query<R>`	`setParameter(javax.persistence.Parameter<T> param, T value)`
`Query<R>`	`setParameter(javax.persistence.Parameter<java.time.ZonedDateTime> param, java.time.ZonedDateTime value, javax.persistence.TemporalType temporalType)`
`<P> Query<R>`	`setParameter(QueryParameter<P> parameter, P val, javax.persistence.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>`	`setParameter(java.lang.String name, java.util.Calendar value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(java.lang.String name, java.time.Instant value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(java.lang.String name, java.time.LocalDateTime value, javax.persistence.TemporalType temporalType)`
`Query<R>`	`setParameter(java.lang.String name, java.lang.Object value)` Bind a named query parameter using its inferred Type.
`Query<R>`	`setParameter(java.lang.String name, java.lang.Object val, Type type)` Bind a named query parameter using the supplied Type
`Query<R>`	`setParameter(java.lang.String name, java.time.OffsetDateTime value, javax.persistence.TemporalType temporalType)`
`<P> Query<R>`	`setParameter(java.lang.String name, P val, javax.persistence.TemporalType temporalType)` Bind a named query parameter as some form of date/time using the indicated temporal-type.
`Query<R>`	`setParameter(java.lang.String name, java.time.ZonedDateTime value, javax.persistence.TemporalType temporalType)`
`<P> Query<R>`	`setParameterList(QueryParameter<P> parameter, java.util.Collection<P> values)` Bind multiple values to a query parameter using its inferred Type.
`Query<R>`	`setParameterList(java.lang.String name, java.util.Collection values)` Bind multiple values to a named query parameter.
`Query<R>`	`setParameterList(java.lang.String name, java.util.Collection values, Type type)` Bind multiple values to a named query parameter.
`Query<R>`	`setParameterList(java.lang.String name, java.lang.Object[] values)` Bind multiple values to a named query parameter.
`Query<R>`	`setParameterList(java.lang.String name, java.lang.Object[] values, Type type)` Bind multiple values to a named query parameter.
`default Query<R>`	`setParameters(java.lang.Object[] values, Type[] types)` Deprecated. (since 5.2) Bind values individually
`Query<R>`	`setProperties(java.util.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>`	`setProperties(java.lang.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>`	`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, java.io.Serializable val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setSerializable(java.lang.String name, java.io.Serializable val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setShort(int position, short val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setShort(java.lang.String name, short val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setString(int position, java.lang.String val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setString(java.lang.String name, java.lang.String val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setText(int position, java.lang.String val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setText(java.lang.String name, java.lang.String val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`default Query<R>`	`setTime(int position, java.util.Date val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setTime(java.lang.String name, java.util.Date val)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`Query<R>`	`setTimeout(int timeout)` Set the query timeout in seconds.
`default Query<R>`	`setTimestamp(int position, java.util.Date val)` Deprecated. (since 5.2) use `setParameter(int, Object)` or `setParameter(int, Object, Type)` instead
`default Query<R>`	`setTimestamp(java.lang.String name, java.util.Date value)` Deprecated. (since 5.2) use `setParameter(String, Object)` or `setParameter(String, Object, Type)` instead
`java.util.stream.Stream<R>`	`stream()` Retrieve a Stream over the query results.
`R`	`uniqueResult()` Convenience method to return a single instance that matches the query, or `null` if the query returns no results.
`java.util.Optional<R>`	`uniqueResultOptional()`

Methods inherited from interface org.hibernate.Query
determineProperBooleanType, determineProperBooleanType, getFlushMode, getNamedParameters, getReturnAliases, getReturnTypes, getTimeout, isCacheable, isReadOnly, iterate

Methods inherited from interface javax.persistence.Query
executeUpdate, getFirstResult, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

- Method Detail
 - getProducer
```
QueryProducer getProducer()
```
 Get the QueryProducer this Query originates from.
 - getQueryOptions
```
RowSelection getQueryOptions()
```
 "QueryOptions" is a better name, I think, than "RowSelection" -> 6.0
 
 Returns:
 
 Return the encapsulation of this query's options, which includes access to firstRow, maxRows, timeout and fetchSize. Important because this gives access to those values in their Integer form rather than the primitive form (int) required by JPA.
 - uniqueResultOptional
```
java.util.Optional<R> uniqueResultOptional()
```
 - stream
```
java.util.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 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
 - setParameter
```
Query<R> setParameter(javax.persistence.Parameter<java.time.Instant> param,
 java.time.Instant value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(javax.persistence.Parameter<java.time.LocalDateTime> param,
 java.time.LocalDateTime value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(javax.persistence.Parameter<java.time.ZonedDateTime> param,
 java.time.ZonedDateTime value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(javax.persistence.Parameter<java.time.OffsetDateTime> param,
 java.time.OffsetDateTime value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(java.lang.String name,
 java.time.Instant value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(java.lang.String name,
 java.time.LocalDateTime value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(java.lang.String name,
 java.time.ZonedDateTime value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(java.lang.String name,
 java.time.OffsetDateTime value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(int position,
 java.time.Instant value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(int position,
 java.time.LocalDateTime value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(int position,
 java.time.ZonedDateTime value,
 javax.persistence.TemporalType temporalType)
```
 - setParameter
```
Query<R> setParameter(int position,
 java.time.OffsetDateTime value,
 javax.persistence.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.
 
 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.
 
 Parameters:
 
 scrollMode - The scroll mode
 
 Returns:
 
 the result iterator
 
 See Also:
 
 ScrollableResults, ScrollMode
 - list
```
java.util.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[].
 
 Returns:
 
 the result list
 - getResultList
```
default java.util.List<R> getResultList()
```
 Specified by:
 
 getResultList in interface javax.persistence.Query
 
 Specified by:
 
 getResultList in interface javax.persistence.TypedQuery<R>
 - uniqueResult
```
R uniqueResult()
```
 Description copied from interface: Query
 
 Convenience method to return a single instance that matches the query, or null if the query returns no results.
 
 Returns:
 
 the single result or null
 - getSingleResult
```
default R getSingleResult()
```
 Specified by:
 
 getSingleResult in interface javax.persistence.Query
 
 Specified by:
 
 getSingleResult in interface javax.persistence.TypedQuery<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 interface BasicQueryContract
 
 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 interface BasicQueryContract
 
 Returns:
 
 The query CacheMode.
 
 See Also:
 
 Session.getCacheMode(), CacheMode
 - getCacheRegion
```
java.lang.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 on Query.isCacheable() for more information). null indicates that the default region should be used.
 
 Specified by:
 
 getCacheRegion in interface BasicQueryContract
 
 Returns:
 
 The specified cache region name into which query results should be placed; null indicates the default region.
 - getFetchSize
```
java.lang.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 via Statement.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 interface BasicQueryContract
 
 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.
 
 Returns:
 
 The LockOptions
 
 See Also:
 
 LockOptions
 - getComment
```
java.lang.String getComment()
```
 Description copied from interface: Query
 
 Obtain the comment currently associated with this query. Provided SQL commenting is enabled (generally by enabling the hibernate.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.
 
 Returns:
 
 The comment.
 - getQueryString
```
java.lang.String getQueryString()
```
 Description copied from interface: Query
 
 Get the query string.
 
 Returns:
 
 the query string
 - getParameterMetadata
```
ParameterMetadata getParameterMetadata()
```
 Description copied from interface: Query
 
 Access to information about query parameters.
 
 Returns:
 
 information about query parameters.
 - setMaxResults
```
Query<R> setMaxResults(int maxResult)
```
 Specified by:
 
 setMaxResults in interface javax.persistence.Query
 
 Specified by:
 
 setMaxResults in interface javax.persistence.TypedQuery<R>
 - setFirstResult
```
Query<R> setFirstResult(int startPosition)
```
 Specified by:
 
 setFirstResult in interface javax.persistence.Query
 
 Specified by:
 
 setFirstResult in interface javax.persistence.TypedQuery<R>
 - setHint
```
Query<R> setHint(java.lang.String hintName,
 java.lang.Object value)
```
 Specified by:
 
 setHint in interface javax.persistence.Query
 
 Specified by:
 
 setHint in interface javax.persistence.TypedQuery<R>
 - setParameter
```
<T> Query<R> setParameter(javax.persistence.Parameter<T> param,
 T value)
```
 Specified by:
 
 setParameter in interface javax.persistence.Query
 
 Specified by:
 
 setParameter in interface javax.persistence.TypedQuery<R>
 - setParameter
```
Query<R> setParameter(javax.persistence.Parameter<java.util.Calendar> param,
 java.util.Calendar value,
 javax.persistence.TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface javax.persistence.Query
 
 Specified by:
 
 setParameter in interface javax.persistence.TypedQuery<R>
 - setParameter
```
Query<R> setParameter(javax.persistence.Parameter<java.util.Date> param,
 java.util.Date value,
 javax.persistence.TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface javax.persistence.Query
 
 Specified by:
 
 setParameter in interface javax.persistence.TypedQuery<R>
 - setParameter
```
Query<R> setParameter(java.lang.String name,
 java.lang.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, and Query.setParameter(String, Object, Type) should be used instead
 
 Specified by:
 
 setParameter in interface javax.persistence.Query
 
 Specified by:
 
 setParameter in interface javax.persistence.TypedQuery<R>
 
 Parameters:
 
 name - the parameter name
 
 value - the (possibly-null) parameter value
 
 Returns:
 
 this, for method chaining
 - setParameter
```
Query<R> setParameter(java.lang.String name,
 java.lang.Object val,
 Type type)
```
 Description copied from interface: Query
 
 Bind a named query parameter using the supplied Type
 
 Parameters:
 
 name - the name of the parameter
 
 val - the possibly-null parameter value
 
 type - the Hibernate type
 
 Returns:
 
 this, for method chaining
 - setParameter
```
Query<R> setParameter(java.lang.String name,
 java.util.Calendar value,
 javax.persistence.TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface javax.persistence.Query
 
 Specified by:
 
 setParameter in interface javax.persistence.TypedQuery<R>
 - setParameter
```
Query<R> setParameter(java.lang.String name,
 java.util.Date value,
 javax.persistence.TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface javax.persistence.Query
 
 Specified by:
 
 setParameter in interface javax.persistence.TypedQuery<R>
 - setParameter
```
Query<R> setParameter(int position,
 java.lang.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, and Query.setParameter(int, Object, Type) should be used instead
 
 Specified by:
 
 setParameter in interface javax.persistence.Query
 
 Specified by:
 
 setParameter in interface javax.persistence.TypedQuery<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,
 java.util.Calendar value,
 javax.persistence.TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface javax.persistence.Query
 
 Specified by:
 
 setParameter in interface javax.persistence.TypedQuery<R>
 - setParameter
```
Query<R> setParameter(int position,
 java.util.Date value,
 javax.persistence.TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface javax.persistence.Query
 
 Specified by:
 
 setParameter in interface javax.persistence.TypedQuery<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, and Query.setParameter(QueryParameter, Object, Type) should be used instead
 
 Parameters:
 
 parameter - The query parameter memento
 
 val - the possibly-null parameter value
 
 Returns:
 
 this, for method chaining
 - setParameter
```
 Query<R> setParameter(int position,
 P val,
 javax.persistence.TemporalType temporalType)
```
 Description copied from interface: Query
 
 Bind a positional query parameter as some form of date/time using the indicated temporal-type.
 
 Parameters:
 
 position - the position of the parameter in the query string, numbered from 0.
 
 val - the possibly-null parameter value
 
 temporalType - the temporal-type to use in binding the date/time
 
 Returns:
 
 this, for method chaining
 - setParameter
```
 Query<R> setParameter(QueryParameter parameter,
 P val,
 Type type)
```
 Description copied from interface: Query
 
 Bind a query parameter using the supplied Type
 
 Parameters:
 
 parameter - The query parameter memento
 
 val - the possibly-null parameter value
 
 type - the Hibernate type
 
 Returns:
 
 this, for method chaining
 - setParameter
```
Query<R> setParameter(int position,
 java.lang.Object val,
 Type type)
```
 Description copied from interface: Query
 
 Bind a value to a JDBC-style query parameter.
 
 Parameters:
 
 position - the position of the parameter in the query string, numbered from 0.
 
 val - the possibly-null parameter value
 
 type - the Hibernate type
 
 Returns:
 
 this, for method chaining
 - setParameter
```
 Query<R> setParameter(QueryParameter parameter,
 P val,
 javax.persistence.TemporalType temporalType)
```
 Description copied from interface: Query
 
 Bind a query parameter as some form of date/time using the indicated temporal-type.
 
 Parameters:
 
 parameter - The query parameter memento
 
 val - the possibly-null parameter value
 
 temporalType - the temporal-type to use in binding the date/time
 
 Returns:
 
 this, for method chaining
 - setParameter
```
 Query<R> setParameter(java.lang.String name,
 P val,
 javax.persistence.TemporalType temporalType)
```
 Description copied from interface: Query
 
 Bind a named query parameter as some form of date/time using the indicated temporal-type.
 
 Parameters:
 
 name - the parameter name
 
 val - the possibly-null parameter value
 
 temporalType - the temporal-type to use in binding the date/time
 
 Returns:
 
 this, for method chaining
 - setFlushMode
```
Query<R> setFlushMode(javax.persistence.FlushModeType flushMode)
```
 Specified by:
 
 setFlushMode in interface javax.persistence.Query
 
 Specified by:
 
 setFlushMode in interface javax.persistence.TypedQuery<R>
 - setLockMode
```
Query<R> setLockMode(javax.persistence.LockModeType lockMode)
```
 Specified by:
 
 setLockMode in interface javax.persistence.Query
 
 Specified by:
 
 setLockMode in interface javax.persistence.TypedQuery<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 interface BasicQueryContract
 
 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 interface BasicQueryContract
 
 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 interface BasicQueryContract
 
 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 interface BasicQueryContract
 
 Parameters:
 
 cacheable - Should the query results be cacheable?
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.isCacheable()
 - setCacheRegion
```
Query<R> setCacheRegion(java.lang.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 interface BasicQueryContract
 
 Parameters:
 
 cacheRegion - the name of a query cache region, or null 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 interface BasicQueryContract
 
 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 interface BasicQueryContract
 
 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, use Query.setLockMode(String, LockMode).
 Parameters:
 
 lockOptions - The lock options to apply to the query.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getLockOptions()
 - setLockMode
```
Query<R> setLockMode(java.lang.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 internal LockOptions. 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).
 
 Parameters:
 
 alias - a query alias, or "this" for a collection filter
 
 lockMode - The lock mode to apply.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getLockOptions()
 - setComment
```
Query<R> setComment(java.lang.String comment)
```
 Description copied from interface: Query
 
 Set the comment for this query.
 
 Parameters:
 
 comment - The human-readable comment
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getComment()
 - addQueryHint
```
Query<R> addQueryHint(java.lang.String hint)
```
 Description copied from interface: Query
 
 Add a DB query hint to the SQL. These differ from JPA's QueryHint, 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.
 
 Parameters:
 
 hint - The database specific query hint to add.
 - setParameterList
```
 Query<R> setParameterList(QueryParameter parameter,
 java.util.Collection 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).
 
 Parameters:
 
 parameter - the parameter memento
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
Query<R> setParameterList(java.lang.String name,
 java.util.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).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
Query<R> setParameterList(java.lang.String name,
 java.util.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).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 type - the Hibernate type of the values
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
Query<R> setParameterList(java.lang.String name,
 java.lang.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).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 type - the Hibernate type of the values
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
Query<R> setParameterList(java.lang.String name,
 java.lang.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).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setProperties
```
Query<R> setProperties(java.lang.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.
 
 Parameters:
 
 bean - any JavaBean or POJO
 
 Returns:
 
 this, for method chaining
 - setProperties
```
Query<R> setProperties(java.util.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.
 
 Parameters:
 
 bean - a java.util.Map
 
 Returns:
 
 this, for method chaining
 - setFlushMode
```
@Deprecated
default Query<R> setFlushMode(FlushMode flushMode)
```
 Deprecated. (since 5.2) use setHibernateFlushMode(org.hibernate.FlushMode) instead
 
 (Re)set the current FlushMode in effect for this query.
 
 Specified by:
 
 setFlushMode in interface BasicQueryContract
 
 Parameters:
 
 flushMode - The new FlushMode to use.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 getHibernateFlushMode()
 - setString
```
@Deprecated
default Query<R> setString(int position,
 java.lang.String val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional String-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setCharacter
```
@Deprecated
default Query<R> setCharacter(int position,
 char val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional char-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setBoolean
```
@Deprecated
default Query<R> setBoolean(int position,
 boolean val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional boolean-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setByte
```
@Deprecated
default Query<R> setByte(int position,
 byte val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional byte-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setShort
```
@Deprecated
default Query<R> setShort(int position,
 short val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional short-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setInteger
```
@Deprecated
default Query<R> setInteger(int position,
 int val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional int-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setLong
```
@Deprecated
default Query<R> setLong(int position,
 long val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional long-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setFloat
```
@Deprecated
default Query<R> setFloat(int position,
 float val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional float-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setDouble
```
@Deprecated
default Query<R> setDouble(int position,
 double val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional double-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setBinary
```
@Deprecated
default Query<R> setBinary(int position,
 byte[] val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional binary-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setText
```
@Deprecated
default Query<R> setText(int position,
 java.lang.String val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional String-valued parameter using streaming.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setSerializable
```
@Deprecated
default Query<R> setSerializable(int position,
 java.io.Serializable val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional binary-valued parameter using serialization.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setLocale
```
@Deprecated
default Query<R> setLocale(int position,
 java.util.Locale val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional Locale-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setBigDecimal
```
@Deprecated
default Query<R> setBigDecimal(int position,
 java.math.BigDecimal val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional BigDecimal-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setBigInteger
```
@Deprecated
default Query<R> setBigInteger(int position,
 java.math.BigInteger val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional BigDecimal-valued parameter.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setDate
```
@Deprecated
default Query<R> setDate(int position,
 java.util.Date val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional Date-valued parameter using just the Date portion.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setTime
```
@Deprecated
default Query<R> setTime(int position,
 java.util.Date val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional Date-valued parameter using just the Time portion.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setTimestamp
```
@Deprecated
default Query<R> setTimestamp(int position,
 java.util.Date val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional Date-valued parameter using the full Timestamp.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setCalendar
```
@Deprecated
default Query<R> setCalendar(int position,
 java.util.Calendar val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional Calendar-valued parameter using the full Timestamp portion.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setCalendarDate
```
@Deprecated
default Query<R> setCalendarDate(int position,
 java.util.Calendar val)
```
 Deprecated. (since 5.2) use setParameter(int, Object) or setParameter(int, Object, Type) instead
 
 Bind a positional Calendar-valued parameter using just the Date portion.
 
 Parameters:
 
 position - The parameter position
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setString
```
@Deprecated
default Query<R> setString(java.lang.String name,
 java.lang.String val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named String-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setCharacter
```
@Deprecated
default Query<R> setCharacter(java.lang.String name,
 char val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named char-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setBoolean
```
@Deprecated
default Query<R> setBoolean(java.lang.String name,
 boolean val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named boolean-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setByte
```
@Deprecated
default Query<R> setByte(java.lang.String name,
 byte val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named byte-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setShort
```
@Deprecated
default Query<R> setShort(java.lang.String name,
 short val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named short-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setInteger
```
@Deprecated
default Query<R> setInteger(java.lang.String name,
 int val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named int-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setLong
```
@Deprecated
default Query<R> setLong(java.lang.String name,
 long val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named long-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setFloat
```
@Deprecated
default Query<R> setFloat(java.lang.String name,
 float val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named float-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setDouble
```
@Deprecated
default Query<R> setDouble(java.lang.String name,
 double val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named double-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setBinary
```
@Deprecated
default Query<R> setBinary(java.lang.String name,
 byte[] val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named binary-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setText
```
@Deprecated
default Query<R> setText(java.lang.String name,
 java.lang.String val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named String-valued parameter using streaming.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setSerializable
```
@Deprecated
default Query<R> setSerializable(java.lang.String name,
 java.io.Serializable val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named binary-valued parameter using serialization.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setLocale
```
@Deprecated
default Query<R> setLocale(java.lang.String name,
 java.util.Locale val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named Locale-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setBigDecimal
```
@Deprecated
default Query<R> setBigDecimal(java.lang.String name,
 java.math.BigDecimal val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named BigDecimal-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setBigInteger
```
@Deprecated
default Query<R> setBigInteger(java.lang.String name,
 java.math.BigInteger val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named BigInteger-valued parameter.
 
 Parameters:
 
 name - The parameter name
 
 val - The bind value
 
 Returns:
 
 this, for method chaining
 - setDate
```
@Deprecated
default Query<R> setDate(java.lang.String name,
 java.util.Date val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind the val (time is truncated) of a given Date object to a named query parameter.
 
 Parameters:
 
 name - The name of the parameter
 
 val - The val object
 
 Returns:
 
 this, for method chaining
 - setTime
```
@Deprecated
default Query<R> setTime(java.lang.String name,
 java.util.Date val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind the time (val is truncated) of a given Date object to a named query parameter.
 
 Parameters:
 
 name - The name of the parameter
 
 val - The val object
 
 Returns:
 
 this, for method chaining
 - setTimestamp
```
@Deprecated
default Query<R> setTimestamp(java.lang.String name,
 java.util.Date value)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind the value and the time of a given Date object to a named query parameter.
 
 Parameters:
 
 name - The name of the parameter
 
 value - The value object
 
 Returns:
 
 this, for method chaining
 - setCalendar
```
@Deprecated
default Query<R> setCalendar(java.lang.String name,
 java.util.Calendar value)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named Calendar-valued parameter using the full Timestamp.
 
 Parameters:
 
 name - The parameter name
 
 value - The bind value
 
 Returns:
 
 this, for method chaining
 - setCalendarDate
```
@Deprecated
default Query<R> setCalendarDate(java.lang.String name,
 java.util.Calendar value)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind a named Calendar-valued parameter using just the Date portion.
 
 Parameters:
 
 name - The parameter name
 
 value - The bind value
 
 Returns:
 
 this, for method chaining
 - setEntity
```
@Deprecated
Query<R> setEntity(int position,
 java.lang.Object val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind an instance of a mapped persistent class to a JDBC-style query parameter. Use setParameter(int, Object) for null values.
 
 Parameters:
 
 position - the position of the parameter in the query string, numbered from 0.
 
 val - a non-null instance of a persistent class
 
 Returns:
 
 this, for method chaining
 - setEntity
```
@Deprecated
Query<R> setEntity(java.lang.String name,
 java.lang.Object val)
```
 Deprecated. (since 5.2) use setParameter(String, Object) or setParameter(String, Object, Type) instead
 
 Bind an instance of a mapped persistent class to a named query parameter. Use setParameter(String, Object) for null values.
 
 Parameters:
 
 name - the name of the parameter
 
 val - a non-null instance of a persistent class
 
 Returns:
 
 this, for method chaining
 - 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.
 
 Parameters:
 
 transformer - The transformer to apply
 
 Returns:
 
 this (for method chaining)
 - setParameters
```
@Deprecated
default Query<R> setParameters(java.lang.Object[] values,
 Type[] types)
```
 Deprecated. (since 5.2) Bind values individually
 
 Bind 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,
 
 Parameters:
 
 types - The types
 
 values - The values
 
 Returns:
 
 this, for method chaining
 - getResultStream
```
default java.util.stream.Stream<R> getResultStream()
```
 JPA 2.2 defines the getResultStream method so to get a Stream from the JDBC ResultSet. Hibernate 5.2 already defines the stream() method, so getResultStream can delegate to it.
 
 Returns:
 
 The results Stream
 
 Since:
 
 5.2.11

Interface Query<R>

Method Summary

Methods inherited from interface org.hibernate.Query

Methods inherited from interface javax.persistence.Query

Method Detail

getProducer

getQueryOptions

uniqueResultOptional

stream

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

scroll

scroll

list

getResultList

uniqueResult

getSingleResult

getHibernateFlushMode

getCacheMode

getCacheRegion

getFetchSize

getLockOptions

getComment

getQueryString

getParameterMetadata

setMaxResults

setFirstResult

setHint

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setFlushMode

setLockMode

setReadOnly

setHibernateFlushMode

setCacheMode

setCacheable

setCacheRegion

setTimeout

setFetchSize

setLockOptions

setLockMode

setComment

addQueryHint

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setProperties

setProperties

setFlushMode

setString

setCharacter

setBoolean

setByte

setShort