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
FETCHGRAPH
Hint providing a "fetchgraph" EntityGraph.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 byDialect.useFollowOnLocking(QueryParameters)
.static String
LOADGRAPH
Hint providing a "loadgraph" EntityGraph.static String
NATIVE_LOCKMODE
Available to apply lock mode to a native SQL query since JPA requires thatQuery.setLockMode(javax.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_JPA
Apply a JPA query timeout, which is defined in milliseconds.
-
-
-
Field Detail
-
CACHE_MODE
public static final String CACHE_MODE
The cache mode to use.
-
CACHE_REGION
public static final String CACHE_REGION
The cache region to use.
-
CACHEABLE
public static final String CACHEABLE
Are the query results cacheable?
-
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.
-
FETCH_SIZE
public static final String FETCH_SIZE
Defines the JDBC fetch size to use.
-
FLUSH_MODE
public static final String FLUSH_MODE
The flush mode to associate with the execution of the query.
-
READ_ONLY
public static final String READ_ONLY
Should entities returned from the query be set in read only mode?
-
TIMEOUT_HIBERNATE
public static final String TIMEOUT_HIBERNATE
Apply a Hibernate query timeout, which is defined in seconds.
-
TIMEOUT_JPA
public static final String TIMEOUT_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 thatQuery.setLockMode(javax.persistence.LockModeType)
throw an IllegalStateException if called for a native query. Accepts aLockModeType
or aLockMode
- See Also:
- Constant Field Values
-
FETCHGRAPH
public static final String FETCHGRAPH
Hint providing a "fetchgraph" EntityGraph. Attributes explicitly specified as AttributeNodes are treated as FetchType.EAGER (via join fetch or subsequent select). Note: Currently, attributes that are not specified are treated as FetchType.LAZY or FetchType.EAGER depending on the attribute's definition in metadata, rather than forcing FetchType.LAZY.- See Also:
- Constant Field Values
-
LOADGRAPH
public static final String LOADGRAPH
Hint providing a "loadgraph" EntityGraph. Attributes explicitly specified as AttributeNodes are treated as FetchType.EAGER (via join fetch or subsequent select). Attributes that are not specified are treated as FetchType.LAZY or FetchType.EAGER depending on the attribute's definition in metadata- 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 byDialect.useFollowOnLocking(QueryParameters)
. A value oftrue
enables follow-on-locking, whereas a value offalse
disables it. If the value isnull
, the theDialect
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 oftrue
enables pass-distinct-through, whereas a value offalse
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 "whitespace"-separated list of the spaces
- See Also:
SynchronizeableQuery
, Constant Field Values
-
-