Class HibernateJpaDialect

java.lang.Object

org.springframework.orm.jpa.DefaultJpaDialect

org.springframework.orm.jpa.vendor.HibernateJpaDialect

All Implemented Interfaces:

Serializable, PersistenceExceptionTranslator, JpaDialect

public class HibernateJpaDialect
extends DefaultJpaDialect

JpaDialect implementation for Hibernate. Compatible with Hibernate ORM 7.x and 8.x.

Since:

2.0

Author:

Juergen Hoeller, Costin Leau

See Also:

• HibernateJpaVendorAdapter
• Session.setHibernateFlushMode(FlushMode)
• Transaction.setTimeout(int)
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
HibernateJpaDialect()

Method Summary

Modifier and Type	Method	Description
Object	beginTransaction(jakarta.persistence.EntityManager entityManager, TransactionDefinition definition)	This implementation invokes the standard JPA Transaction.begin method.
void	cleanupTransaction(@Nullable Object transactionData)	This implementation resets the flush mode if necessary.
StatelessSession	deriveEntityAgent(jakarta.persistence.EntityManager entityManager, @Nullable Map<?,?> properties)	Derive a new EntityAgent from the given EntityManager if possible, sharing the transactional context.
ConnectionHandle	getJdbcConnection(jakarta.persistence.EntityManager entityManager, boolean readOnly)	This implementation always returns null, indicating that no JDBC Connection can be provided.
protected @Nullable FlushMode	prepareFlushMode(Session session, boolean readOnly)
Object	prepareTransaction(jakarta.persistence.EntityManager entityManager, boolean readOnly, @Nullable String name)	This implementation returns transaction data for a flush mode reset if necessary, calling DefaultJpaDialect.prepareFlushMode(EntityManager, boolean) accordingly.
void	setJdbcExceptionTranslator(@Nullable SQLExceptionTranslator exceptionTranslator)	Set the JDBC exception translator for Hibernate exception translation purposes.
void	setPrepareConnection(boolean prepareConnection)	Set whether to prepare the underlying JDBC Connection of a transactional Hibernate Session, that is, whether to apply a transaction-specific isolation level and/or the transaction's read-only flag to the underlying JDBC Connection.
@Nullable DataAccessException	translateExceptionIfPossible(RuntimeException ex)	This implementation delegates to EntityManagerFactoryUtils.

Methods inherited from class DefaultJpaDialect

prepareFlushMode, releaseJdbcConnection

Methods inherited from class Object

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

Constructor Details

HibernateJpaDialect

public HibernateJpaDialect()

Method Details

setPrepareConnection

public void setPrepareConnection(boolean prepareConnection)

Set whether to prepare the underlying JDBC Connection of a transactional Hibernate Session, that is, whether to apply a transaction-specific isolation level and/or the transaction's read-only flag to the underlying JDBC Connection.

Default is "true". If you turn this flag off, JPA transaction management will not support per-transaction isolation levels anymore. It will not call Connection.setReadOnly(true) for read-only transactions anymore either. If this flag is turned off, no cleanup of a JDBC Connection is required after a transaction, since no Connection settings will get modified.

NOTE: The default behavior in terms of read-only handling changed in Spring 4.1, propagating the read-only status to the JDBC Connection now, analogous to other Spring transaction managers. This may have the effect that you're running into read-only enforcement now where previously write access has accidentally been tolerated: Please revise your transaction declarations accordingly, removing invalid read-only markers if necessary.

Since:

4.1

See Also:

• Connection.setTransactionIsolation(int)
• Connection.setReadOnly(boolean)

setJdbcExceptionTranslator

public void setJdbcExceptionTranslator(@Nullable SQLExceptionTranslator exceptionTranslator)

Set the JDBC exception translator for Hibernate exception translation purposes.

Applied to any detected SQLException root cause of a Hibernate JDBCException, overriding Hibernate's own SQLException translation (which is based on a Hibernate Dialect for a specific target database).

As of 6.1, also applied to TransactionException translation with a SQLException root cause (where Hibernate does not translate itself at all), overriding Spring's default SQLExceptionSubclassTranslator there.

Parameters:

exceptionTranslator - the SQLExceptionTranslator to delegate to, or null for none. By default, a SQLExceptionSubclassTranslator will be used for TransactionException translation as of 6.1; this can be reverted to pre-6.1 behavior through setting null here.

Since:

5.1

See Also:

• SQLException
• JDBCException
• SQLExceptionSubclassTranslator
• SQLErrorCodeSQLExceptionTranslator

beginTransaction

public Object beginTransaction(jakarta.persistence.EntityManager entityManager,
 TransactionDefinition definition)
                        throws jakarta.persistence.PersistenceException,
SQLException,
TransactionException

Description copied from class: DefaultJpaDialect

This implementation invokes the standard JPA Transaction.begin method. Throws an InvalidIsolationLevelException if a non-default isolation level is set.

This implementation returns transaction data for a flush mode reset if necessary, calling DefaultJpaDialect.prepareFlushMode(EntityManager, boolean) accordingly. Can be reused in subclasses or alternatively replaced with custom flush mode handling.

Specified by:

beginTransaction in interface JpaDialect

Overrides:

beginTransaction in class DefaultJpaDialect

Parameters:

entityManager - the EntityManager to begin a JPA transaction on

definition - the Spring transaction definition that defines semantics

Returns:

an arbitrary object that holds transaction data, if any (to be passed into JpaDialect.cleanupTransaction(Object)). May implement the SavepointManager interface.

Throws:

jakarta.persistence.PersistenceException - if thrown by JPA methods

SQLException - if thrown by JDBC methods

TransactionException - in case of invalid arguments

See Also:

• EntityTransaction.begin()
• InvalidIsolationLevelException
• DefaultJpaDialect.prepareFlushMode(EntityManager, boolean)
• DefaultJpaDialect.cleanupTransaction(Object)

prepareTransaction

public Object prepareTransaction(jakarta.persistence.EntityManager entityManager,
 boolean readOnly,
 @Nullable String name)
                          throws jakarta.persistence.PersistenceException

Description copied from class: DefaultJpaDialect

This implementation returns transaction data for a flush mode reset if necessary, calling DefaultJpaDialect.prepareFlushMode(EntityManager, boolean) accordingly.

Specified by:

prepareTransaction in interface JpaDialect

Overrides:

prepareTransaction in class DefaultJpaDialect

Parameters:

entityManager - the EntityManager to begin a JPA transaction on

readOnly - whether the transaction is supposed to be read-only

name - the name of the transaction (if any)

Returns:

an arbitrary object that holds transaction data, if any (to be passed into JpaDialect.cleanupTransaction(Object))

Throws:

jakarta.persistence.PersistenceException - if thrown by JPA methods

See Also:

• DefaultJpaDialect.prepareFlushMode(EntityManager, boolean)

prepareFlushMode

protected @Nullable FlushMode prepareFlushMode(Session session,
 boolean readOnly)
                                        throws jakarta.persistence.PersistenceException

Throws:

jakarta.persistence.PersistenceException

cleanupTransaction

public void cleanupTransaction(@Nullable Object transactionData)

Description copied from class: DefaultJpaDialect

This implementation resets the flush mode if necessary.

Specified by:

cleanupTransaction in interface JpaDialect

Overrides:

cleanupTransaction in class DefaultJpaDialect

Parameters:

transactionData - arbitrary object that holds transaction data, if any (as returned by beginTransaction or prepareTransaction)

See Also:

• DefaultJpaDialect.prepareFlushMode(EntityManager, boolean)

getJdbcConnection

public ConnectionHandle getJdbcConnection(jakarta.persistence.EntityManager entityManager,
 boolean readOnly)
                                   throws jakarta.persistence.PersistenceException,
SQLException

Description copied from class: DefaultJpaDialect

This implementation always returns null, indicating that no JDBC Connection can be provided.

Specified by:

getJdbcConnection in interface JpaDialect

Overrides:

getJdbcConnection in class DefaultJpaDialect

Parameters:

entityManager - the current JPA EntityManager

readOnly - whether the Connection is only needed for read-only purposes

Returns:

a handle for the Connection, to be passed into releaseJdbcConnection, or null if no JDBC Connection can be retrieved

Throws:

jakarta.persistence.PersistenceException - if thrown by JPA methods

SQLException - if thrown by JDBC methods

See Also:

• JpaDialect.releaseJdbcConnection(ConnectionHandle, EntityManager)
• ConnectionHandle.getConnection()
• SimpleConnectionHandle
• JpaTransactionManager.setDataSource(DataSource)

deriveEntityAgent

public StatelessSession deriveEntityAgent(jakarta.persistence.EntityManager entityManager,
 @Nullable Map<?,?> properties)
                                   throws jakarta.persistence.PersistenceException

Description copied from class: DefaultJpaDialect

Derive a new EntityAgent from the given EntityManager if possible, sharing the transactional context.

NOTE: This method is designed for Spring's early JPA 4.0 support. For JPA 3.2 compatibility, the return type cannot be enforced as jakarta.persistence.EntityAgent. Subclasses should override it with their specific EntityAgent type if possible, or otherwise just EntityAgent, as a covariant return type. This will make it forward-compatible with a future variant of this method in the JpaDialect interface itself.

Overrides:

deriveEntityAgent in class DefaultJpaDialect

Parameters:

entityManager - the current JPA EntityManager

properties - the properties for the EntityAgent, if any

Returns:

the new EntityAgent instance, or null if none can be derived

Throws:

jakarta.persistence.PersistenceException - if thrown by JPA methods

translateExceptionIfPossible

public @Nullable DataAccessException translateExceptionIfPossible(RuntimeException ex)

Description copied from class: DefaultJpaDialect

This implementation delegates to EntityManagerFactoryUtils.

Specified by:

translateExceptionIfPossible in interface PersistenceExceptionTranslator

Overrides:

translateExceptionIfPossible in class DefaultJpaDialect

Parameters:

ex - a RuntimeException to translate

Returns:

the corresponding DataAccessException (or null if the exception could not be translated, as in this case it may result from user code rather than from an actual persistence problem)

See Also:

• EntityManagerFactoryUtils.convertJpaAccessExceptionIfPossible(RuntimeException)