Package org.hibernate.jpa

Interface HibernateHints

All Known Subinterfaces:

AvailableHints

public interface HibernateHints

List of Hibernate-specific (extension) hints available to query, load and lock scenarios.

Some hints are only effective in certain scenarios, which is noted on each constant's documentation

Field Summary

Fields

Modifier and Type	Field	Description
static String	HINT_CACHE_MODE	Hint for specifying the CacheMode to use
static String	HINT_CACHE_REGION	Hint for specifying the region of the query cache into which the results should be stored
static String	HINT_CACHEABLE	Hint for specifying whether results from a query should be stored in the query cache
static String	HINT_CALLABLE_FUNCTION	Whether to treat a ProcedureCall or StoredProcedureQuery as a call to a function rather than a call to a procedure
static String	HINT_COMMENT	Hint for specifying a database comment to be applied to the SQL sent to the database.
static String	HINT_FETCH_SIZE	Hint for specifying a fetch size to be applied to the JDBC statement.
static String	HINT_FLUSH_MODE	Hint for specifying the FlushMode to apply to an EntityManager or a Query
static String	HINT_FOLLOW_ON_LOCKING	Hint to enable/disable the follow-on-locking mechanism provided by Dialect.useFollowOnLocking(java.lang.String, org.hibernate.query.spi.QueryOptions).
static String	HINT_NATIVE_LOCK_MODE	Hint for specifying the lock mode to apply to the results of a native query.
static String	HINT_NATIVE_SPACES	Hint for specifying query spaces to be applied to a native query.
static String	HINT_READ_ONLY	Hint for specifying that objects loaded into the persistence context as a result of a query should be associated with the persistence context as read-only.
static String	HINT_TIMEOUT	Hint for specifying a Query timeout, in seconds.

Field Detail

HINT_FLUSH_MODE

static final String HINT_FLUSH_MODE

Hint for specifying the FlushMode to apply to an EntityManager or a Query

See Also:

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

HINT_TIMEOUT

static final String HINT_TIMEOUT

Hint for specifying a Query timeout, in seconds.

See Also:

Query.setTimeout(int), Statement.setQueryTimeout(int), SpecHints.HINT_SPEC_QUERY_TIMEOUT, Constant Field Values

HINT_READ_ONLY

static final String HINT_READ_ONLY

Hint for specifying that objects loaded into the persistence context as a result of a query should be associated with the persistence context as read-only.

See Also:

Query.setReadOnly(boolean), Session.setDefaultReadOnly(boolean), Constant Field Values

HINT_FETCH_SIZE

static final String HINT_FETCH_SIZE

Hint for specifying a fetch size to be applied to the JDBC statement.

See Also:

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

HINT_CACHEABLE

static final String HINT_CACHEABLE

Hint for specifying whether results from a query should be stored in the query cache

See Also:

Query.setCacheable(boolean), Constant Field Values

HINT_CACHE_REGION

static final String HINT_CACHE_REGION

Hint for specifying the region of the query cache into which the results should be stored

See Also:

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

HINT_CACHE_MODE

static final String HINT_CACHE_MODE

Hint for specifying the CacheMode to use

See Also:

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

HINT_COMMENT

static final String HINT_COMMENT

Hint for specifying a database comment to be applied to the SQL sent to the database.

See Also:

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

HINT_FOLLOW_ON_LOCKING

static final String HINT_FOLLOW_ON_LOCKING

Hint to enable/disable the follow-on-locking mechanism provided by Dialect.useFollowOnLocking(java.lang.String, org.hibernate.query.spi.QueryOptions).

A value of true enables follow-on-locking, whereas a value of false disables it. If the value is null, the Dialect's default strategy is used.

Since:

5.2

See Also:

LockOptions.setFollowOnLocking(Boolean), Constant Field Values

HINT_NATIVE_LOCK_MODE

static final String HINT_NATIVE_LOCK_MODE

Hint for specifying the lock mode to apply to the results of a native query.

While Hibernate supports applying lock-mode to a native-query, the JPA specification 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

HINT_NATIVE_SPACES

static final String HINT_NATIVE_SPACES

Hint for specifying query spaces to be applied to a native 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 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 SynchronizeableQuery and FlushMode.MANUAL for more information.

See Also:

SynchronizeableQuery, HINT_FLUSH_MODE, Constant Field Values

HINT_CALLABLE_FUNCTION

static final String HINT_CALLABLE_FUNCTION

Whether to treat a ProcedureCall or StoredProcedureQuery as a call to a function rather than a call to a procedure

See Also:

Constant Field Values