Top Description Fields
org.hibernate.jpa

public Interface SpecHints

Known Direct Subinterfaces
org.hibernate.jpa.AvailableHints
Imports
java.util.Map, org.hibernate.graph.GraphSemantic, jakarta.persistence.LockModeType
The hints explicitly defined by the Jakarta Persistence specification which are available for both queries and loading.
Author
Steve Ebersole
See Also
jakarta.persistence.EntityManager#setProperty, jakarta.persistence.EntityManager#find(Class, Object, Map), jakarta.persistence.EntityManager#find(Class, Object, LockModeType, Map), jakarta.persistence.EntityManager#lock(Object, LockModeType, Map), jakarta.persistence.Query#setHint

Field Summary

Modifier and TypeField and Description
public static final String
HINT_SPEC_CACHE_RETRIEVE_MODE

Hint specifying how Hibernate should interact with the second level cache when it has the opportunity to retrieve data from the cache.

public static final String
HINT_SPEC_CACHE_STORE_MODE

Hint specifying how Hibernate should interact with the second level cache when it has the opportunity to store data in the cache.

public static final String
HINT_SPEC_FETCH_GRAPH

Hint providing a jakarta.persistence.EntityGraph which should be interpreted as a "fetch graph".

public static final String
HINT_SPEC_LOAD_GRAPH

Hint providing a jakarta.persistence.EntityGraph which should be interpreted as a "load graph".

public static final String
HINT_SPEC_LOCK_SCOPE

Hint indicating whether to extend pessimistic locking to associated tables.

public static final String
HINT_SPEC_LOCK_TIMEOUT

Hint requesting a pessimistic lock timeout (in milliseconds).

public static final String
HINT_SPEC_QUERY_TIMEOUT

The Jakarta Persistence defined hint for requesting a timeout be applied to a jakarta.persistence.Query executions.

Field Detail

HINT_SPEC_CACHE_RETRIEVE_MODEback to summary
public static final String HINT_SPEC_CACHE_RETRIEVE_MODE

Hint specifying how Hibernate should interact with the second level cache when it has the opportunity to retrieve data from the cache. The value must be a jakarta.persistence.CacheRetrieveMode.

See Also
jakarta.persistence.CacheRetrieveMode, jakarta.persistence.EntityManager#setProperty, jakarta.persistence.Query#setHint, org.hibernate.CacheMode
HINT_SPEC_CACHE_STORE_MODEback to summary
public static final String HINT_SPEC_CACHE_STORE_MODE

Hint specifying how Hibernate should interact with the second level cache when it has the opportunity to store data in the cache. The value must be a jakarta.persistence.CacheStoreMode.

See Also
jakarta.persistence.CacheStoreMode, jakarta.persistence.EntityManager#setProperty, jakarta.persistence.Query#setHint, org.hibernate.CacheMode
HINT_SPEC_FETCH_GRAPHback to summary
public static final String HINT_SPEC_FETCH_GRAPH

Hint providing a jakarta.persistence.EntityGraph which should be interpreted as a "fetch graph".

See Also
GraphSemantic#FETCH
HINT_SPEC_LOAD_GRAPHback to summary
public static final String HINT_SPEC_LOAD_GRAPH

Hint providing a jakarta.persistence.EntityGraph which should be interpreted as a "load graph".

See Also
GraphSemantic#LOAD
HINT_SPEC_LOCK_SCOPEback to summary
public static final String HINT_SPEC_LOCK_SCOPE

Hint indicating whether to extend pessimistic locking to associated tables. Expected to be an instance of jakarta.persistence.PessimisticLockScope

HINT_SPEC_LOCK_TIMEOUTback to summary
public static final String HINT_SPEC_LOCK_TIMEOUT

Hint requesting a pessimistic lock timeout (in milliseconds).

HINT_SPEC_QUERY_TIMEOUTback to summary
public static final String HINT_SPEC_QUERY_TIMEOUT

The Jakarta Persistence defined hint for requesting a timeout be applied to a jakarta.persistence.Query executions.

Implementation Specification

Not valid for load and/or lock operations