org.hibernate.jpa

Class QueryHints

java.lang.Object

org.hibernate.jpa.QueryHints

Direct Known Subclasses:

QueryHints

public class QueryHints
extends Object

Defines the supported JPA query hints

Author:

Steve Ebersole

Field Summary

Fields

Modifier and Type	Field and Description
static String	HINT_CACHE_MODE The hint key for specifying the cache mode (CacheMode) to be in effect for the execution of the hinted query.
static String	HINT_CACHE_REGION The hint key for specifying the name of the cache region (within Hibernate's query result cache region) to use for storing the query results.
static String	HINT_CACHEABLE The hint key for specifying whether the query results should be cached for the next (cached) execution of the "same query".
static String	HINT_COMMENT The hint key for specifying a comment which is to be embedded into the SQL sent to the database.
static String	HINT_FETCH_SIZE The hint key for specifying a JDBC fetch size, used when executing the resulting SQL.
static String	HINT_FETCHGRAPH Hint providing a "fetchgraph" EntityGraph.
static String	HINT_FLUSH_MODE The hint key for specifying the flush mode (FlushMode) to be in effect for the execution of the hinted query.
static String	HINT_LOADGRAPH Hint providing a "loadgraph" EntityGraph.
static String	HINT_NATIVE_LOCKMODE
static String	HINT_READONLY The hint key for specifying that objects loaded into the persistence context as a result of this query execution should be associated with the persistence context as read-only.
static String	HINT_TIMEOUT Deprecated. use SPEC_HINT_TIMEOUT instead
static String	SPEC_HINT_TIMEOUT The hint key for specifying a query timeout per JPA, which defines the timeout in milliseconds

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryHints()

Method Summary

Modifier and Type	Method and Description
static Set<String>	getDefinedHints()

Methods inherited from class java.lang.Object

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

Field Detail

HINT_TIMEOUT

@Deprecated
public static final String HINT_TIMEOUT

Deprecated. use SPEC_HINT_TIMEOUT instead

The hint key for specifying a query timeout per Hibernate O/RM, which defines the timeout in seconds.

See Also:

Constant Field Values

SPEC_HINT_TIMEOUT

public static final String SPEC_HINT_TIMEOUT

The hint key for specifying a query timeout per JPA, which defines the timeout in milliseconds

See Also:

Constant Field Values

HINT_COMMENT

public static final String HINT_COMMENT

The hint key for specifying a comment which is to be embedded into the SQL sent to the database.

See Also:

Constant Field Values

HINT_FETCH_SIZE

public static final String HINT_FETCH_SIZE

The hint key for specifying a JDBC fetch size, used when executing the resulting SQL.

See Also:

Constant Field Values

HINT_CACHEABLE

public static final String HINT_CACHEABLE

The hint key for specifying whether the query results should be cached for the next (cached) execution of the "same query".

See Also:

Constant Field Values

HINT_CACHE_REGION

public static final String HINT_CACHE_REGION

The hint key for specifying the name of the cache region (within Hibernate's query result cache region) to use for storing the query results.

See Also:

Constant Field Values

HINT_READONLY

public static final String HINT_READONLY

The hint key for specifying that objects loaded into the persistence context as a result of this query execution should be associated with the persistence context as read-only.

See Also:

Constant Field Values

HINT_CACHE_MODE

public static final String HINT_CACHE_MODE

The hint key for specifying the cache mode (CacheMode) to be in effect for the execution of the hinted query.

See Also:

Constant Field Values

HINT_FLUSH_MODE

public static final String HINT_FLUSH_MODE

The hint key for specifying the flush mode (FlushMode) to be in effect for the execution of the hinted query.

See Also:

Constant Field Values

HINT_NATIVE_LOCKMODE

public static final String HINT_NATIVE_LOCKMODE

See Also:

Constant Field Values

HINT_FETCHGRAPH

public static final String HINT_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

HINT_LOADGRAPH

public static final String HINT_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

Constructor Detail

QueryHints

protected QueryHints()

Method Detail

getDefinedHints

public static Set<String> getDefinedHints()