public Interface HibernateHints

Hint to set the batch size for batch fetching for a given EntityManager.

See Also

org.hibernate.cfg.AvailableSettings#DEFAULT_BATCH_FETCH_SIZE, jakarta.persistence.EntityManager#setProperty(String, Object)

Hint for specifying the org.hibernate.CacheMode to use.

See Also

org.hibernate.query.SelectionQuery#setCacheMode

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

See Also

org.hibernate.query.SelectionQuery#setCacheRegion

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

See Also

org.hibernate.query.SelectionQuery#setCacheable

Whether to treat a org.hibernate.procedure.ProcedureCall or jakarta.persistence.StoredProcedureQuery as a call to a function rather than a call to a procedure.

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

See Also

org.hibernate.query.SelectionQuery#setComment

Hint to enable subselect fetching for a given EntityManager.

See Also

org.hibernate.cfg.AvailableSettings#USE_SUBSELECT_FETCH, jakarta.persistence.EntityManager#setProperty(String, Object)

Hint to enable a fetch profile for a given EntityManager.

See Also

org.hibernate.Session#enableFetchProfile(String), jakarta.persistence.EntityManager#setProperty(String, Object)

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

See Also

org.hibernate.query.SelectionQuery#setFetchSize, java.sql.Statement#setFetchSize

Hint for specifying the org.hibernate.FlushMode to apply to an jakarta.persistence.EntityManager or jakarta.persistence.Query.

See Also

org.hibernate.query.Query#setHibernateFlushMode, org.hibernate.Session#setHibernateFlushMode

Hint to enable or disable the follow-on locking mechanism provided by org.hibernate.dialect.Dialect#useFollowOnLocking.

A value of true enables follow-on-locking, whereas a value of false disables it. If the value is null, the dialect itself will determine whether follow-on locking is used.

Since

5.2

See Also

org.hibernate.LockOptions#setFollowOnLocking(Boolean)

Hint to set the batch size for JDBC batching for a given EntityManager.

See Also

org.hibernate.cfg.AvailableSettings#STATEMENT_BATCH_SIZE, jakarta.persistence.EntityManager#setProperty(String, Object)

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

Accepts either a jakarta.persistence.LockModeType or a org.hibernate.LockMode.

Hint for specifying the query spaces that affect the results of a native query.

Passed value can be any of:

• a org.hibernate.mapping.List of the spaces,
• an array of the spaces, or
• a string with a whitespace-separated list of the spaces.

Typically, these are the names of tables which are referenced by the query.

See Also

org.hibernate.query.SynchronizeableQuery#addSynchronizedQuerySpace, HINT_FLUSH_MODE, org.hibernate.annotations.NamedNativeQuery#querySpaces

Hint to enable or disable the query plan caching.

By default, query plan caching is enabled for HQL queries and immutable criteria queries i.e. created with org.hibernate.cfg.AvailableSettings#CRITERIA_COPY_TREE. Query plan caching can be disabled for any query by setting this property to false. Query plan caching can be enabled for mutable criteria queries by setting this property to true.

Setting this property to true for mutable criteria queries can lead to cache trashing, because the query plan is cached based on a copy of the criteria query. This is mostly useful when the same org.hibernate.query.Query should be executed multiple times, but with different parameter values to avoid re-translation of the criteria query.

Note that setting this property to true does not override the basic safety measures of Hibernate. Hibernate will never cache query plans that are not safe to cache, regardless of the value of this property.

Since

6.3

See Also

org.hibernate.query.SelectionQuery#setQueryPlanCacheable

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

See Also

org.hibernate.query.SelectionQuery#setReadOnly, org.hibernate.Session#setDefaultReadOnly

Hint for specifying the tenant id to use when creating an EntityManager.

See Also

org.hibernate.SessionBuilder#tenantIdentifier, jakarta.persistence.EntityManagerFactory#createEntityManager(java.util.Map)

Hint for specifying a query timeout, in seconds.

See Also

org.hibernate.query.CommonQueryContract#setTimeout, java.sql.Statement#setQueryTimeout, SpecHints#HINT_SPEC_QUERY_TIMEOUT