Package org.hibernate.annotations

Class QueryHints

java.lang.Object

org.hibernate.annotations.QueryHints

public class QueryHints
extends Object

Consolidation of hints available to Hibernate JPA queries. Mainly used to define features available on Hibernate queries that have no corollary in JPA queries.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CACHE_MODE	The cache mode to use.
static String	CACHE_REGION	The cache region to use.
static String	CACHEABLE	Are the query results cacheable?
static String	CALLABLE	Is the query callable? Note: only valid for named native sql queries.
static String	COMMENT	Defines a comment to be applied to the SQL sent to the database.
static String	FETCH_SIZE	Defines the JDBC fetch size to use.
static String	FLUSH_MODE	The flush mode to associate with the execution of the query.
static String	FOLLOW_ON_LOCKING	Hint to enable/disable the follow-on-locking mechanism provided by org.hibernate.dialect.Dialect#useFollowOnLocking(QueryParameters).
static String	NATIVE_LOCKMODE	Available to apply lock mode to a native SQL query since JPA requires that Query.setLockMode(jakarta.persistence.LockModeType) throw an IllegalStateException if called for a native query.
static String	NATIVE_SPACES	Hint for specifying query spaces to be applied to a native (SQL) query.
static String	PASS_DISTINCT_THROUGH	Hint to enable/disable the pass-distinct-through mechanism.
static String	READ_ONLY	Should entities returned from the query be set in read only mode?
static String	TIMEOUT_HIBERNATE	Apply a Hibernate query timeout, which is defined in seconds.
static String	TIMEOUT_JAKARTA_JPA	Apply a JPA query timeout, which is defined in milliseconds.
static String	TIMEOUT_JPA	Apply a JPA query timeout, which is defined in milliseconds.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CACHE_MODE

public static final String CACHE_MODE

The cache mode to use.

See Also:

Query.setCacheMode(org.hibernate.CacheMode), NativeQuery.setCacheMode(org.hibernate.CacheMode), Constant Field Values

CACHE_REGION

public static final String CACHE_REGION

The cache region to use.

See Also:

Query.setCacheRegion(java.lang.String), NativeQuery.setCacheRegion(java.lang.String), Constant Field Values

CACHEABLE

public static final String CACHEABLE

Are the query results cacheable?

See Also:

Query.setCacheable(boolean), NativeQuery.setCacheable(boolean), Constant Field Values

CALLABLE

public static final String CALLABLE

Is the query callable? Note: only valid for named native sql queries.

See Also:

Constant Field Values

COMMENT

public static final String COMMENT

Defines a comment to be applied to the SQL sent to the database.

See Also:

Query.setComment(java.lang.String), NativeQuery.setComment(java.lang.String), Constant Field Values

FETCH_SIZE

public static final String FETCH_SIZE

Defines the JDBC fetch size to use.

See Also:

Query.setFetchSize(int), NativeQuery.setFetchSize(int), Constant Field Values

FLUSH_MODE

public static final String FLUSH_MODE

The flush mode to associate with the execution of the query.

See Also:

Query.setHibernateFlushMode(org.hibernate.FlushMode), NativeQuery.setHibernateFlushMode(org.hibernate.FlushMode), Session.setHibernateFlushMode(org.hibernate.FlushMode), Constant Field Values

READ_ONLY

public static final String READ_ONLY

Should entities returned from the query be set in read only mode?

See Also:

Query.setReadOnly(boolean), NativeQuery.setReadOnly(boolean), Session.setReadOnly(java.lang.Object, boolean), Constant Field Values

TIMEOUT_HIBERNATE

public static final String TIMEOUT_HIBERNATE

Apply a Hibernate query timeout, which is defined in seconds.

See Also:

Query.setTimeout(int), NativeQuery.setTimeout(int), Constant Field Values

TIMEOUT_JPA

public static final String TIMEOUT_JPA

Apply a JPA query timeout, which is defined in milliseconds.

See Also:

Constant Field Values

TIMEOUT_JAKARTA_JPA

public static final String TIMEOUT_JAKARTA_JPA

Apply a JPA query timeout, which is defined in milliseconds.

See Also:

Constant Field Values

NATIVE_LOCKMODE

public static final String NATIVE_LOCKMODE

Available to apply lock mode to a native SQL query since JPA requires that Query.setLockMode(jakarta.persistence.LockModeType) throw an IllegalStateException if called for a native query.

Accepts a LockModeType or a LockMode

See Also:

Constant Field Values

FOLLOW_ON_LOCKING

public static final String FOLLOW_ON_LOCKING

Hint to enable/disable the follow-on-locking mechanism provided by org.hibernate.dialect.Dialect#useFollowOnLocking(QueryParameters). A value of true enables follow-on-locking, whereas a value of false disables it. If the value is null, the Dialect strategy is going to be used instead.

Since:

5.2

See Also:

Constant Field Values

PASS_DISTINCT_THROUGH

public static final String PASS_DISTINCT_THROUGH

Hint to enable/disable the pass-distinct-through mechanism. A value of true enables pass-distinct-through, whereas a value of false disables it. When the pass-distinct-through is disabled, the HQL and JPQL distinct clause is no longer passed to the SQL statement.

Since:

5.2

See Also:

Constant Field Values

NATIVE_SPACES

public static final String NATIVE_SPACES

Hint for specifying query spaces to be applied to a native (SQL) query. Passed value can be any of:

• List of the spaces
• array of the spaces
• String as "whitespace"-separated list of the spaces

Note that the passed space need not match to any real spaces/tables in the underlying query. This can be used to completely circumvent the auto-flush checks as well as any cache invalidation that might occur as part of a flush. See the documentation on SynchronizeableQuery for details. See also FlushMode.MANUAL

See Also:

SynchronizeableQuery, FLUSH_MODE, Constant Field Values