Interface Query<T>

Type Parameters:

T - The result type for selection queries or the target type for mutation statements.

All Superinterfaces:

CommonQueryContract, Query

All Known Subinterfaces:

MutationOrSelectionQuery, MutationQueryImplementor<T>, NativeQuery<T>, NativeQueryImplementor<R>, ProcedureCallImplementor<R>, QueryImplementor<T>, SelectionQuery<R>, SelectionQueryImplementor<R>

@Incubating
public interface Query<T>
extends CommonQueryContract

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

• a query written in HQL or native SQL,
• a named query written in HQL or native SQL, or
• a criteria query.

The subtype NativeQuery represents a query written in the native SQL dialect of the database.

This interface fills a very similar role to Query in JPA, acting as a bridge to client code written for older versions of the query APIs in JPA and Hibernate. Older versions did not carefully distinguish selection queries from insert, update, and delete mutation statements. Every instance of Query may logically be classified as one or the other.

Direct use of this interface to execute a query or statement is now discouraged. Instead, SelectionQuery should be used to execute a selection query, and MutationQuery should be used to execute a mutation statement. Therefore, operations of this interface which are only relevant to selection queries, or only relevant to mutation statements, are now marked as deprecated.

• Selection queries are usually executed using getResultList(), getSingleResult(), or getSingleResultOrNull(), with the methods setMaxResults(int) and setFirstResult(int) controlling limits and pagination. All these methods are marked as deprecated, and should be called via an instance of SelectionQuery.
• Mutation statements are usually executed using executeUpdate(), which is marked as deprecated, or using MutationQuery.execute().
• The various overloads of setParameter(String, Object) and setParameter(int, Object) allow arguments to be bound to named and ordinal parameters defined by the query.

See Also:

• Query
• SelectionQuery
• MutationQuery

API Note:

Like Query in JPA 4, this interface is now essentially redundant. Newly written code should always prefer SelectionQuery or MutationQuery.

Method Summary

Modifier and Type	Method	Description
Query<T>	addQueryHint(String hint)	Add a database query hint to the SQL query.
Query<T>	disableFetchProfile(String profileName)	Deprecated, for removal: This API element is subject to removal in a future version.
Query<T>	enableFetchProfile(String profileName)	Deprecated, for removal: This API element is subject to removal in a future version.
int	executeUpdate()	Deprecated, for removal: This API element is subject to removal in a future version. Use MutationQuery instead for queries which mutate data.
CacheMode	getCacheMode()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as caching is only relevant for selection queries
String	getCacheRegion()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as caching is only relevant for selection queries
CacheRetrieveMode	getCacheRetrieveMode()	Deprecated. Use SelectionQuery instead as second-level cache interaction is only relevant for queries which return results.
CacheStoreMode	getCacheStoreMode()	Deprecated. Use SelectionQuery instead as second-level cache interaction is only relevant for queries which return results.
Integer	getFetchSize()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as fetch size is only relevant for selection queries
int	getFirstResult()	Deprecated. Use SelectionQuery instead as applying result limits is only relevant for queries which return results.
default FlushModeType	getFlushMode()	Deprecated.
LockMode	getHibernateLockMode()	Deprecated. Use SelectionQuery instead as locking is only relevant for queries which return results.
LockModeType	getLockMode()	Deprecated. Use SelectionQuery instead as locking is only relevant for queries which return results.
int	getMaxResults()	Deprecated. Use SelectionQuery instead as applying result limits is only relevant for queries which return results.
QueryOptions	getQueryOptions()	Deprecated, for removal: This API element is subject to removal in a future version. The various Query<T> subtypes already expose all relevant options; furthermore, this operation is a layer-breaker, exposing the QueryOptions SPI type via an API.
String	getQueryString()	The Query<T> as a string, or null in the case of a criteria query.
default List<T>	getResultList()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.
default Stream<T>	getResultStream()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.
T	getSingleResult()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.
T	getSingleResultOrNull()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.
boolean	isCacheable()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as caching is only relevant for selection queries
boolean	isQueryPlanCacheable()	Whether the execution plan for this query is cached.
boolean	isReadOnly()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as read-only mode is only relevant for selection queries
List<T>	list()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.
ScrollableResults<T>	scroll()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.
ScrollableResults<T>	scroll(ScrollMode scrollMode)	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.
Query<T>	setCacheable(boolean cacheable)	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as caching is only relevant for selection queries
Query<T>	setCacheMode(CacheMode cacheMode)	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as caching is only relevant for selection queries
Query<T>	setCacheRegion(String cacheRegion)	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as caching is only relevant for selection queries
Query<T>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)	Deprecated. Use SelectionQuery instead as second-level cache interaction is only relevant for queries which return results.
Query<T>	setCacheStoreMode(CacheStoreMode cacheStoreMode)	Deprecated. Use SelectionQuery instead as second-level cache interaction is only relevant for queries which return results.
Query<T>	setComment(String comment)	Set the comment for this query.
<P> Query<T>	setConvertedParameter(int position, P value, Class<? extends AttributeConverter<P,?>> converter)
<P> Query<T>	setConvertedParameter(String name, P value, Class<? extends AttributeConverter<P,?>> converter)
Query<T>	setEntityGraph(EntityGraph<? super T> graph, GraphSemantic semantic)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer passing the entity-graph while creating the query - SharedSessionContract.createSelectionQuery(String, EntityGraph)
Query<T>	setFetchSize(int fetchSize)	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as fetch size is only relevant for selection queries
Query<T>	setFirstResult(int startPosition)	Deprecated. Use SelectionQuery instead as applying result limits is only relevant for queries which return results.
default Query<T>	setFlushMode(FlushModeType flushMode)	Deprecated. Use setQueryFlushMode(QueryFlushMode) instead.
Query<T>	setFollowOnStrategy(Locking.FollowOn strategy)	Deprecated. Use SelectionQuery instead as locking is only relevant for queries which return results.
Query<T>	setHibernateLockMode(LockMode lockMode)	Deprecated. Use SelectionQuery instead as locking is only relevant for queries which return results.
Query<T>	setHint(String hintName, Object value)	Set a hint.
Query<T>	setLockMode(LockModeType lockMode)	Deprecated. Use SelectionQuery instead as locking is only relevant for queries which return results.
Query<T>	setMaxResults(int maxResults)	Deprecated. Use SelectionQuery instead as applying result limits is only relevant for queries which return results.
Query<T>	setParameter(int parameter, Object argument)	Bind the given argument to an ordinal query parameter.
Query<T>	setParameter(int parameter, Instant argument, TemporalType temporalType)	Deprecated.
Query<T>	setParameter(int parameter, Calendar argument, TemporalType temporalType)	Deprecated.
Query<T>	setParameter(int parameter, Date argument, TemporalType temporalType)	Deprecated.
<P> Query<T>	setParameter(int parameter, P argument, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> Query<T>	setParameter(int parameter, P argument, Class<P> type)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type.
Query<T>	setParameter(Parameter<Calendar> parameter, Calendar argument, TemporalType temporalType)	Deprecated.
Query<T>	setParameter(Parameter<Date> parameter, Date argument, TemporalType temporalType)	Deprecated.
<P> Query<T>	setParameter(Parameter<P> parameter, P argument)
Query<T>	setParameter(String parameter, Object argument)	Bind the given argument to a named query parameter.
Query<T>	setParameter(String parameter, Instant argument, TemporalType temporalType)	Deprecated.
Query<T>	setParameter(String parameter, Calendar argument, TemporalType temporalType)	Deprecated.
Query<T>	setParameter(String parameter, Date argument, TemporalType temporalType)	Deprecated.
<P> Query<T>	setParameter(String parameter, P argument, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> Query<T>	setParameter(String parameter, P argument, Class<P> type)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type.
<P> Query<T>	setParameter(QueryParameter<P> parameter, P argument)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> Query<T>	setParameter(QueryParameter<P> parameter, P argument, Type<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.
<P> Query<T>	setParameter(QueryParameter<P> parameter, P argument, Class<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use.
Query<T>	setParameterList(int parameter, Object[] arguments)	Bind multiple arguments to an ordinal query parameter.
Query<T>	setParameterList(int parameter, Collection arguments)	Bind multiple arguments to an ordinal query parameter.
<P> Query<T>	setParameterList(int parameter, Collection<? extends P> arguments, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> Query<T>	setParameterList(int parameter, Collection<? extends P> arguments, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
<P> Query<T>	setParameterList(int parameter, P[] arguments, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> Query<T>	setParameterList(int parameter, P[] arguments, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
Query<T>	setParameterList(String parameter, Object[] values)	Bind multiple arguments to a named query parameter.
Query<T>	setParameterList(String parameter, Collection arguments)	Bind multiple arguments to a named query parameter.
<P> Query<T>	setParameterList(String parameter, Collection<? extends P> arguments, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> Query<T>	setParameterList(String parameter, Collection<? extends P> arguments, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).
<P> Query<T>	setParameterList(String parameter, P[] arguments, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> Query<T>	setParameterList(String parameter, P[] arguments, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use.
<P> Query<T>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> Query<T>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.
<P> Query<T>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
<P> Query<T>	setParameterList(QueryParameter<P> parameter, P[] arguments)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> Query<T>	setParameterList(QueryParameter<P> parameter, P[] arguments, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.
<P> Query<T>	setParameterList(QueryParameter<P> parameter, P[] arguments, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
Query<T>	setParameters(Object... arguments)
Query<T>	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<T>	setProperties(Map bean)	Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
Query<T>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
Query<T>	setQueryPlanCacheable(boolean queryPlanCacheable)	Enable or disable query plan caching for this query, if available.
Query<T>	setReadOnly(boolean readOnly)	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as read-only mode is only relevant for selection queries
Query<T>	setResultListTransformer(ResultListTransformer<T> transformer)	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as result list transformation is only relevant for queries which return results.
Query<T>	setTimeout(int timeout)	Specify a JDBC query timeout to use when executing the query.
Query<T>	setTimeout(Timeout timeout)	Specify a JDBC query timeout to use when executing the query.
Query<T>	setTimeout(Integer timeout)	Specify a JDBC query timeout to use when executing the query.
<X> Query<X>	setTupleTransformer(TupleTransformer<X> transformer)	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead as tuple transformation is only relevant for queries which return results.
default Stream<T>	stream()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.
T	uniqueResult()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.
Optional<T>	uniqueResultOptional()	Deprecated, for removal: This API element is subject to removal in a future version. Use SelectionQuery instead for queries which return results.

Methods inherited from interface CommonQueryContract

getComment, getEffectiveFlushMode, getParameterMetadata, getQueryFlushMode, getSession, getTimeout

Methods inherited from interface Query

getHints, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

Method Details

getQueryString

@Nullable
String getQueryString()

The Query<T> as a string, or null in the case of a criteria query.

setQueryFlushMode

@Nonnull
Query<T> setQueryFlushMode(@Nonnull
 QueryFlushMode queryFlushMode)

Set the QueryFlushMode to use for this query.

A QueryFlushMode only affects stateful sessions. A stateless session has no persistence context to flush.

Specified by:

setQueryFlushMode in interface CommonQueryContract

Specified by:

setQueryFlushMode in interface Query

See Also:

• Session.getHibernateFlushMode()

setComment

@Nonnull
Query<T> setComment(@Nullable
 String comment)

Set the comment for this query.

If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.

SQL commenting may be enabled using the configuration property "hibernate.use_sql_comments".

Specified by:

setComment in interface CommonQueryContract

See Also:

• CommonQueryContract.getComment()

addQueryHint

@Nonnull
Query<T> addQueryHint(@Nonnull
 String hint)

Add a database query hint to the SQL query.

Multiple query hints may be specified. The operation Dialect.getQueryHintString(String, List) determines how the hint is actually added to the SQL query.

Specified by:

addQueryHint in interface CommonQueryContract

setTimeout

@Nonnull
Query<T> setTimeout(int timeout)

Specify a JDBC query timeout to use when executing the query.

Specified by:

setTimeout in interface CommonQueryContract

See Also:

• CommonQueryContract.getTimeout()
• Timeouts
• CommonQueryContract.setTimeout(Timeout)

API Note:

Since this is a legacy method of Hibernate, the timeout value is expressed in seconds.

setTimeout

@Nonnull
Query<T> setTimeout(@Nullable
 Integer timeout)

Specify a JDBC query timeout to use when executing the query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface Query

See Also:

• CommonQueryContract.getTimeout()
• Timeouts
• CommonQueryContract.setTimeout(Timeout)

API Note:

Since this method is inherited from JPA, the timeout is expressed in milliseconds.

setTimeout

@Nonnull
Query<T> setTimeout(@Nullable
 Timeout timeout)

Specify a JDBC query timeout to use when executing the query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface Query

isQueryPlanCacheable

boolean isQueryPlanCacheable()

Whether the execution plan for this query is cached.

Since:

6.3

setQueryPlanCacheable

@Nonnull
Query<T> setQueryPlanCacheable(boolean queryPlanCacheable)

Enable or disable query plan caching for this query, if available.

Since:

6.3

See Also:

• isQueryPlanCacheable()

setHint

@Nonnull
Query<T> setHint(@Nonnull
 String hintName,
 @Nullable
 Object value)

Set a hint. Hints are a JPA-standard way to control provider-specific behavior affecting execution of the query. Clients of this native Hibernate API should make use of type safe operations of this interface and of its subtypes. For example, SelectionQuery.setCacheRegion(String) is preferred over HibernateHints.HINT_CACHE_REGION.

Since JPA 4, TypedQuery.Option and Statement.Option compete with query hints, offering a more type safe way to accommodate vendor extensions.

The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface Query

See Also:

• HibernateHints
• SpecHints

setParameter

@Nonnull
Query<T> setParameter(@Nonnull
 String parameter,
 @Nullable
 Object argument)

Bind the given argument to a named query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• CommonQueryContract.setParameter(String, Object, Class)
• CommonQueryContract.setParameter(String, Object, Type)
• CommonQueryContract.setParameter(int, Object)
• TypedParameterValue

setParameter

@Nonnull
<P> Query<T> setParameter(@Nonnull
 String parameter,
 @Nullable
 P argument,
 @Nonnull
 Class<P> type)

Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(String, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• CommonQueryContract.setParameter(String, Object, Type)
• CommonQueryContract.setParameter(int, Object, Class)

setParameter

@Nonnull
<P> Query<T> setParameter(@Nonnull
 String parameter,
 @Nullable
 P argument,
 @Nonnull
 Type<P> type)

Bind the given argument to a named query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

setParameter

@Nonnull
Query<T> setParameter(int parameter,
 @Nullable
 Object argument)

Bind the given argument to an ordinal query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• CommonQueryContract.setParameter(int, Object, Class)
• CommonQueryContract.setParameter(int, Object, Type)
• CommonQueryContract.setParameter(String, Object)
• TypedParameterValue

setParameters

@Nonnull
Query<T> setParameters(@Nonnull
 Object... arguments)

Specified by:

setParameters in interface CommonQueryContract

Specified by:

setParameters in interface Query

See Also:

• Query.setParameters(Object...)

setParameter

@Nonnull
<P> Query<T> setParameter(int parameter,
 @Nullable
 P argument,
 @Nonnull
 Class<P> type)

Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(int, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

@Nonnull
<P> Query<T> setParameter(int parameter,
 @Nullable
 P argument,
 @Nonnull
 Type<P> type)

Bind the given argument to an ordinal query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

setParameter

@Nonnull
<P> Query<T> setParameter(@Nonnull
 QueryParameter<P> parameter,
 @Nullable
 P argument)

Bind an argument to the query parameter represented by the given QueryParameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

argument - the argument, which might be null

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

@Nonnull
<P> Query<T> setParameter(@Nonnull
 QueryParameter<P> parameter,
 @Nullable
 P argument,
 @Nonnull
 Class<P> type)

Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(QueryParameter, Object).

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

argument - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

@Nonnull
<P> Query<T> setParameter(@Nonnull
 QueryParameter<P> parameter,
 @Nullable
 P argument,
 @Nonnull
 Type<P> type)

Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Parameters:

parameter - the query parameter memento

argument - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

@Nonnull
<P> Query<T> setParameter(@Nonnull
 Parameter<P> parameter,
 @Nullable
 P argument)

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• Query.setParameter(Parameter, Object)

setConvertedParameter

@Nonnull
<P> Query<T> setConvertedParameter(@Nonnull
 String name,
 @Nullable
 P value,
 @Nonnull
 Class<? extends AttributeConverter<P,?>> converter)

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface Query

See Also:

• Query.setConvertedParameter(String, Object, Class)

setConvertedParameter

@Nonnull
<P> Query<T> setConvertedParameter(int position,
 @Nullable
 P value,
 @Nonnull
 Class<? extends AttributeConverter<P,?>> converter)

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface Query

See Also:

• Query.setConvertedParameter(int, Object, Class)

setProperties

@Nonnull
Query<T> setProperties(@Nonnull
 Object bean)

Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.

Specified by:

setProperties in interface CommonQueryContract

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

@Nonnull
Query<T> setProperties(@Nonnull
 Map bean)

Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.

Specified by:

setProperties in interface CommonQueryContract

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

setParameterList

@Nonnull
Query<T> setParameterList(@Nonnull
 String parameter,
 @Nonnull
 Collection arguments)

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 String parameter,
 @Nonnull
 Collection<? extends P> arguments,
 @Nonnull
 Class<P> javaType)

Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 String parameter,
 @Nonnull
 Collection<? extends P> arguments,
 @Nonnull
 Type<P> type)

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
Query<T> setParameterList(@Nonnull
 String parameter,
 @Nonnull
 Object[] values)

Bind multiple arguments to a named query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 String parameter,
 @Nonnull
 P[] arguments,
 @Nonnull
 Class<P> javaType)

Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use. If unable to determine an appropriate Type, CommonQueryContract.setParameterList(String, Collection) is used

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, Object[], Type)

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 String parameter,
 @Nonnull
 P[] arguments,
 @Nonnull
 Type<P> type)

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
Query<T> setParameterList(int parameter,
 @Nonnull
 Collection arguments)

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> Query<T> setParameterList(int parameter,
 @Nonnull
 Collection<? extends P> arguments,
 @Nonnull
 Class<P> javaType)

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

@Nonnull
<P> Query<T> setParameterList(int parameter,
 @Nonnull
 Collection<? extends P> arguments,
 @Nonnull
 Type<P> type)

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
Query<T> setParameterList(int parameter,
 @Nonnull
 Object[] arguments)

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> Query<T> setParameterList(int parameter,
 @Nonnull
 P[] arguments,
 @Nonnull
 Class<P> javaType)

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Object[], Type)

setParameterList

@Nonnull
<P> Query<T> setParameterList(int parameter,
 @Nonnull
 P[] arguments,
 @Nonnull
 Type<P> type)

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 Collection<? extends P> arguments)

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred from the context in which it occurs, and from the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Parameters:

parameter - the parameter memento

arguments - a collection of arguments

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 Collection<? extends P> arguments,
 @Nonnull
 Class<P> javaType)

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, java.util.Collection, Type)

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 Collection<? extends P> arguments,
 @Nonnull
 Type<P> type)

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 P[] arguments)

Bind multiple arguments to the query parameter represented by the given QueryParameter.

The type of the parameter is inferred between the context in which it occurs, the type associated with the QueryParameter and the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Parameters:

parameter - the parameter memento

arguments - a collection of arguments

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 P[] arguments,
 @Nonnull
 Class<P> javaType)

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, Object[], Type)

setParameterList

@Nonnull
<P> Query<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 P[] arguments,
 @Nonnull
 Type<P> type)

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

getFetchSize

@Deprecated(since="8.0",
            forRemoval=true)
@Nullable
Integer getFetchSize()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as fetch size is only relevant for selection queries

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 by JDBC, this value is a hint to the driver to indicate how many rows to fetch from the database when more rows are needed.

Returns:

The timeout in seconds

See Also:

• Statement.getFetchSize()
• Statement.setFetchSize(int)
• JdbcSettings.STATEMENT_FETCH_SIZE

Implementation Note:

JDBC expressly defines this value as a hint. Depending on the driver, it may or may not have any effect on the actual query execution and ResultSet processing .

setFetchSize

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
Query<T> setFetchSize(int fetchSize)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as fetch size is only relevant for selection queries

Specify a JDBC fetch size to use when executing this query.

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• getFetchSize()
• JdbcSettings.STATEMENT_FETCH_SIZE

isReadOnly

@Deprecated(since="8.0",
            forRemoval=true)
boolean isReadOnly()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as read-only mode is only relevant for selection queries

Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context is returned instead.

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.

Returns:

true if the entities and proxies loaded by the query will be put in read-only mode; false otherwise (they will be modifiable)

See Also:

• setReadOnly(boolean)
• PersistenceContext.isDefaultReadOnly()

setReadOnly

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
Query<T> setReadOnly(boolean readOnly)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as read-only mode is only relevant for selection queries

Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context, Session.isDefaultReadOnly().

To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session, use Session.setDefaultReadOnly(boolean).

Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted.

When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting.

The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session beforeQuery the query was executed.

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

isCacheable

@Deprecated(since="8.0",
            forRemoval=true)
boolean isCacheable()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as caching is only relevant for selection queries

Should the results of the query be stored in the second level cache?

This is different to second level caching of any returned entities and collections, which is controlled by getCacheMode().

The query being "eligible" for caching does not necessarily mean its results will be cached. Second-level query caching still has to be enabled on the SessionFactory for this to happen. Usually that is controlled by the configuration setting "hibernate.cache.use_query_cache".

setCacheable

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
Query<T> setCacheable(boolean cacheable)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as caching is only relevant for selection queries

Enable/disable second level query (result) caching for this query.

See Also:

• isCacheable()

getCacheMode

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
CacheMode getCacheMode()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as caching is only relevant for selection queries

Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the session from which it originates.

The CacheMode here affects the use of entity and collection caches as the query result set is processed. For caching of the actual query results, use isCacheable() and getCacheRegion().

In order for this setting to have any affect, second-level caching must be enabled and the entities and collections must be eligible for storage in the second-level cache.

See Also:

• Session.getCacheMode()

setCacheMode

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
Query<T> setCacheMode(@Nonnull
 CacheMode cacheMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as caching is only relevant for selection queries

Set the current CacheMode in effect for this query.

Set it to null to indicate that the CacheMode of the session should be used.

See Also:

• getCacheMode()
• Session.setCacheMode(CacheMode)

getCacheRegion

@Deprecated(since="8.0",
            forRemoval=true)
@Nullable
String getCacheRegion()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as caching is only relevant for selection queries

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 isCacheable() for more information). null indicates that the default region should be used.

setCacheRegion

@Deprecated(since="8.0",
            forRemoval=true)
Query<T> setCacheRegion(@Nullable
 String cacheRegion)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as caching is only relevant for selection queries

Set the name of the cache region where query results should be cached (assuming isCacheable()). null indicates to use the default region.

See Also:

• getCacheRegion()

getCacheStoreMode

@Deprecated(since="8.0")
@Nonnull
CacheStoreMode getCacheStoreMode()

Deprecated.

Use SelectionQuery instead as second-level cache interaction is only relevant for queries which return results.

Specified by:

getCacheStoreMode in interface Query

setCacheStoreMode

@Deprecated(since="8.0")
@Nonnull
Query<T> setCacheStoreMode(@Nonnull
 CacheStoreMode cacheStoreMode)

Deprecated.

Use SelectionQuery instead as second-level cache interaction is only relevant for queries which return results.

Specified by:

setCacheStoreMode in interface Query

getCacheRetrieveMode

@Deprecated(since="8.0")
@Nonnull
CacheRetrieveMode getCacheRetrieveMode()

Deprecated.

Use SelectionQuery instead as second-level cache interaction is only relevant for queries which return results.

Specified by:

getCacheRetrieveMode in interface Query

setCacheRetrieveMode

@Deprecated(since="8.0")
@Nonnull
Query<T> setCacheRetrieveMode(@Nonnull
 CacheRetrieveMode cacheRetrieveMode)

Deprecated.

Use SelectionQuery instead as second-level cache interaction is only relevant for queries which return results.

Specified by:

setCacheRetrieveMode in interface Query

getMaxResults

@Deprecated(since="8.0")
int getMaxResults()

Deprecated.

Use SelectionQuery instead as applying result limits is only relevant for queries which return results.

Specified by:

getMaxResults in interface Query

setMaxResults

@Deprecated(since="8.0")
@Nonnull
Query<T> setMaxResults(int maxResults)

Deprecated.

Use SelectionQuery instead as applying result limits is only relevant for queries which return results.

Specified by:

setMaxResults in interface Query

getFirstResult

@Deprecated(since="8.0")
int getFirstResult()

Deprecated.

Use SelectionQuery instead as applying result limits is only relevant for queries which return results.

Specified by:

getFirstResult in interface Query

setFirstResult

@Deprecated(since="8.0")
@Nonnull
Query<T> setFirstResult(int startPosition)

Deprecated.

Use SelectionQuery instead as applying result limits is only relevant for queries which return results.

Specified by:

setFirstResult in interface Query

getLockMode

@Deprecated(since="8.0")
@Nullable
LockModeType getLockMode()

Deprecated.

Use SelectionQuery instead as locking is only relevant for queries which return results.

Specified by:

getLockMode in interface Query

setLockMode

@Deprecated(since="8.0")
@Nonnull
Query<T> setLockMode(@Nonnull
 LockModeType lockMode)

Deprecated.

Use SelectionQuery instead as locking is only relevant for queries which return results.

Specified by:

setLockMode in interface Query

getHibernateLockMode

@Deprecated(since="8.0")
@Nonnull
LockMode getHibernateLockMode()

Deprecated.

Use SelectionQuery instead as locking is only relevant for queries which return results.

Get the root LockMode for the query, expressed using Hibernate's native LockMode instead of JPA's LockModeType.

See Also:

• getLockMode()

setHibernateLockMode

@Deprecated(since="8.0")
@Nonnull
Query<T> setHibernateLockMode(@Nonnull
 LockMode lockMode)

Deprecated.

Use SelectionQuery instead as locking is only relevant for queries which return results.

Specify the root LockMode for the query using Hibernate's native LockMode.

See Also:

• setLockMode(LockModeType)

setFollowOnStrategy

@Deprecated(since="8.0")
@Nonnull
Query<T> setFollowOnStrategy(@Nonnull
 Locking.FollowOn strategy)

Deprecated.

Use SelectionQuery instead as locking is only relevant for queries which return results.

Control how Hibernate should handle cases where it is determined subsequent SQL queries would be needs to completely accomplish locking as requested.

Parameters:

strategy - The strategy for follow-on locking.

Returns:

this, for method chaining

Since:

7.1

setTupleTransformer

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
<X> Query<X> setTupleTransformer(@Nonnull
 TupleTransformer<X> transformer)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as tuple transformation is only relevant for queries which return results.

Set a TupleTransformer.

Since:

6.0

setResultListTransformer

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
Query<T> setResultListTransformer(@Nonnull
 ResultListTransformer<T> transformer)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead as result list transformation is only relevant for queries which return results.

Set a ResultListTransformer.

Since:

6.0

list

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
List<T> list()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the Query<T> results as a List. If the Query<T> contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].

Returns:

the result list

getResultList

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
default List<T> getResultList()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the Query<T> results as a List. If the Query<T> contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].

Specified by:

getResultList in interface Query

Returns:

the results as a list

Implementation Note:

Delegates to list()

scroll

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
ScrollableResults<T> scroll()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the results in a scrollable form.

This overload simply calls scroll(ScrollMode) using the default scroll mode of the SQL dialect.

API Note:

The exact behavior of this method depends somewhat on the level of JDBC driver support for scrollable ResultSets, and so is not very portable between databases.

scroll

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
ScrollableResults<T> scroll(@Nonnull
 ScrollMode scrollMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the results in a scrollable form. The capabilities of the returned ScrollableResults depend on the specified ScrollMode.

API Note:

Not every JDBC driver supports every ScrollMode.

getResultStream

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
default Stream<T> getResultStream()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the Query<T> results as a Stream. If the Query<T> contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Specified by:

getResultStream in interface Query

Returns:

The results as a Stream

Implementation Note:

Delegates to stream(), which in turn delegates to this method. Implementors should implement at least one of these methods.

stream

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
default Stream<T> stream()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the Query<T> results as a Stream. If the Query<T> contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Returns:

The results as a Stream

Since:

5.2

uniqueResult

@Deprecated(since="8.0",
            forRemoval=true)
@Nullable
T uniqueResult()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the single result of the query, or null if the Query<T> returns no results.

Returns:

the single result or null if there is no result to return

Throws:

NonUniqueResultException - if there is more than one matching result

getSingleResult

@Deprecated(since="8.0",
            forRemoval=true)
T getSingleResult()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the single result of the query, throwing an exception if the Query<T> returns no results.

Specified by:

getSingleResult in interface Query

Returns:

the single result, only if there is exactly one

Throws:

NonUniqueResultException - if there is more than one matching result

NoResultException - if there is no result to return

getSingleResultOrNull

@Deprecated(since="8.0",
            forRemoval=true)
@Nullable
T getSingleResultOrNull()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the single result of the query or null if the Query<T> returns no results, throwing and exception if the Query<T> returns more than one result.

Specified by:

getSingleResultOrNull in interface Query

Returns:

the single result, if there is exactly one result, or null if there are no results to return

Throws:

NonUniqueResultException - if there is more than one matching result

uniqueResultOptional

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
Optional<T> uniqueResultOptional()

Deprecated, for removal: This API element is subject to removal in a future version.

Use SelectionQuery instead for queries which return results.

Execute the Query<T> and return the single result of the Query<T> as an instance of Optional.

Returns:

the single result as an Optional

Throws:

NonUniqueResultException - if there is more than one matching result

executeUpdate

@Deprecated(since="8.0",
            forRemoval=true)
int executeUpdate()

Deprecated, for removal: This API element is subject to removal in a future version.

Use MutationQuery instead for queries which mutate data.

Execute an insert, update, or delete statement, and return the number of affected entities.

For use with instances of MutationQuery created using SharedSessionContract.createMutationQuery(String), SharedSessionContract.createNamedMutationQuery(String), SharedSessionContract.createNativeMutationQuery(String), or SharedSessionContract.createMutationQuery(jakarta.persistence.criteria.CriteriaStatement).

Specified by:

executeUpdate in interface Query

Returns:

the number of affected entity instances (may differ from the number of affected rows)

See Also:

• Query.executeUpdate()

API Note:

This method is needed because this interface extends Query, which defines this method. See MutationQuery and SelectionQuery.

enableFetchProfile

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
Query<T> enableFetchProfile(@Nonnull
 String profileName)

Deprecated, for removal: This API element is subject to removal in a future version.

Enable the fetch profile with the given name during execution of this query. If the requested fetch profile is already enabled, the call has no effect.

This is an alternative way to specify the associations which should be fetched as part of the initial query.

Parameters:

profileName - the name of the fetch profile to be enabled

Throws:

UnknownProfileException - Indicates that the given name does not match any known fetch profile names

See Also:

• FetchProfile

disableFetchProfile

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
Query<T> disableFetchProfile(@Nonnull
 String profileName)

Deprecated, for removal: This API element is subject to removal in a future version.

Disable the fetch profile with the given name in this session. If the fetch profile is not currently enabled, the call has no effect.

Parameters:

profileName - the name of the fetch profile to be disabled

Throws:

UnknownProfileException - Indicates that the given name does not match any known fetch profile names

See Also:

• FetchProfile

getFlushMode

@Deprecated(since="7")
@Nonnull
default FlushModeType getFlushMode()

Deprecated.

The JPA FlushModeType in effect for this query. By default, the Query<T> inherits the FlushMode of the Session from which it originates.

Specified by:

getFlushMode in interface Query

See Also:

• CommonQueryContract.getQueryFlushMode()

API Note:

Inherited from Jakarta Persistence. Prefer CommonQueryContract.getQueryFlushMode()

setFlushMode

@Deprecated(since="7")
@Nonnull
default Query<T> setFlushMode(@Nonnull
 FlushModeType flushMode)

Deprecated.

Use setQueryFlushMode(QueryFlushMode) instead.

Set the FlushModeType to use for this query.

Setting this to null ultimately indicates to use the FlushMode of the session. Use setQueryFlushMode(QueryFlushMode) passing QueryFlushMode.NO_FLUSH instead to indicate that no automatic flushing should occur.

Specified by:

setFlushMode in interface Query

See Also:

• CommonQueryContract.getQueryFlushMode()
• setQueryFlushMode(QueryFlushMode)
• Session.getHibernateFlushMode()

API Note:

Inherited from Jakarta Persistence. Prefer setQueryFlushMode(QueryFlushMode)

setEntityGraph

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
Query<T> setEntityGraph(@Nonnull
 EntityGraph<? super T> graph,
 @Nonnull
 GraphSemantic semantic)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer passing the entity-graph while creating the query - SharedSessionContract.createSelectionQuery(String, EntityGraph)

Apply an EntityGraph to the query.

This is an alternative way to specify the associations which should be fetched as part of the initial query.

Since:

6.3

See Also:

• SharedSessionContract.createSelectionQuery(String, EntityGraph)
• MutationOrSelectionQuery.asSelectionQuery(EntityGraph)
• MutationOrSelectionQuery.asSelectionQuery(EntityGraph, GraphSemantic)
• StatementOrTypedQuery.withEntityGraph(EntityGraph)

getQueryOptions

@Deprecated(since="8.0",
            forRemoval=true)
@Nonnull
QueryOptions getQueryOptions()

Deprecated, for removal: This API element is subject to removal in a future version.

The various Query<T> subtypes already expose all relevant options; furthermore, this operation is a layer-breaker, exposing the QueryOptions SPI type via an API.

Get the execution options for this Query. Many of the setters of this object update the state of the returned QueryOptions. This is useful because it gives access to a primitive value in its (nullable) wrapper form, rather than the primitive form as required by JPA. This allows us to distinguish whether a value has been explicitly set by the client.

setParameter

@Deprecated(since="7")
@Nonnull
Query<T> setParameter(@Nonnull
 Parameter<Calendar> parameter,
 @Nullable
 Calendar argument,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
Query<T> setParameter(@Nonnull
 Parameter<Date> parameter,
 @Nullable
 Date argument,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
Query<T> setParameter(@Nonnull
 String parameter,
 @Nullable
 Instant argument,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Bind an Instant value to the named Query<T> parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

setParameter

@Deprecated(since="7")
@Nonnull
Query<T> setParameter(@Nonnull
 String parameter,
 @Nullable
 Calendar argument,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
Query<T> setParameter(@Nonnull
 String parameter,
 @Nullable
 Date argument,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
Query<T> setParameter(int parameter,
 @Nullable
 Instant argument,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Bind an Instant value to the ordinal Query<T> parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

setParameter

@Deprecated(since="7")
@Nonnull
Query<T> setParameter(int parameter,
 @Nullable
 Date argument,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
Query<T> setParameter(int parameter,
 @Nullable
 Calendar argument,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

See Also:

• Query.setParameter(int, Calendar, TemporalType)