Class R2dbcTransactionManager
- All Implemented Interfaces:
- Serializable,- InitializingBean,- ReactiveTransactionManager,- TransactionManager
ReactiveTransactionManager
 implementation for a single R2DBC ConnectionFactory. This class is
 capable of working in any environment with any R2DBC driver, as long as the
 setup uses a ConnectionFactory as its Connection factory
 mechanism. Binds a R2DBC Connection from the specified
 ConnectionFactory to the current subscriber context, potentially
 allowing for one context-bound Connection per ConnectionFactory.
 Note: The ConnectionFactory that this transaction manager
 operates on needs to return independent Connections.
 The Connections may come from a pool (the typical case), but the
 ConnectionFactory must not return scoped Connections
 or the like. This transaction manager will associate Connection
 with context-bound transactions itself, according to the specified propagation
 behavior. It assumes that a separate, independent Connection can
 be obtained even during an ongoing transaction.
 
Application code is required to retrieve the R2DBC Connection via
 ConnectionFactoryUtils.getConnection(ConnectionFactory)
 instead of a standard R2DBC-style ConnectionFactory.create() call.
 Spring classes such as DatabaseClient use this strategy implicitly.
 If not used in combination with this transaction manager, the
 ConnectionFactoryUtils lookup strategy behaves exactly like the
 native ConnectionFactory lookup; it can thus be used in a portable fashion.
 
Alternatively, you can allow application code to work with the standard
 R2DBC lookup pattern ConnectionFactory.create(), for example for code
 that is not aware of Spring at all. In that case, define a
 TransactionAwareConnectionFactoryProxy for your target ConnectionFactory,
 and pass that proxy ConnectionFactory to your DAOs, which will automatically
 participate in Spring-managed transactions when accessing it.
 
This transaction manager triggers flush callbacks on registered transaction
 synchronizations (if synchronization is generally active), assuming resources
 operating on the underlying R2DBC Connection.
 
Spring's TransactionDefinition attributes are carried forward to R2DBC drivers
 using extensible R2DBC TransactionDefinition. Subclasses may
 override createTransactionDefinition(TransactionDefinition) to customize
 transaction definitions for vendor-specific attributes.
- Since:
- 5.3
- Author:
- Mark Paluch, Juergen Hoeller
- See Also:
- 
Nested Class SummaryNested classes/interfaces inherited from class org.springframework.transaction.reactive.AbstractReactiveTransactionManagerAbstractReactiveTransactionManager.SuspendedResourcesHolder
- 
Field SummaryFields inherited from class org.springframework.transaction.reactive.AbstractReactiveTransactionManagerlogger
- 
Constructor SummaryConstructorsConstructorDescriptionCreate a newR2dbcTransactionManagerinstance.R2dbcTransactionManager(ConnectionFactory connectionFactory) Create a newR2dbcTransactionManagerinstance.
- 
Method SummaryModifier and TypeMethodDescriptionvoidInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.protected TransactionDefinitioncreateTransactionDefinition(TransactionDefinition definition) Determine the transaction definition from ourTransactionDefinition.protected DurationdetermineTimeout(TransactionDefinition definition) Determine the actual timeout to use for the given definition.protected reactor.core.publisher.Mono<Void>doBegin(TransactionSynchronizationManager synchronizationManager, Object transaction, TransactionDefinition definition) Begin a new transaction with semantics according to the given transaction definition.protected reactor.core.publisher.Mono<Void>doCleanupAfterCompletion(TransactionSynchronizationManager synchronizationManager, Object transaction) Cleanup resources after transaction completion.protected reactor.core.publisher.Mono<Void>doCommit(TransactionSynchronizationManager TransactionSynchronizationManager, GenericReactiveTransaction status) Perform an actual commit of the given transaction.protected ObjectdoGetTransaction(TransactionSynchronizationManager synchronizationManager) Return a transaction object for the current transaction state.protected reactor.core.publisher.Mono<Void>doResume(TransactionSynchronizationManager synchronizationManager, Object transaction, Object suspendedResources) Resume the resources of the current transaction.protected reactor.core.publisher.Mono<Void>doRollback(TransactionSynchronizationManager TransactionSynchronizationManager, GenericReactiveTransaction status) Perform an actual rollback of the given transaction.protected reactor.core.publisher.Mono<Void>doSetRollbackOnly(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status) Set the given transaction rollback-only.protected reactor.core.publisher.Mono<Object>doSuspend(TransactionSynchronizationManager synchronizationManager, Object transaction) Suspend the resources of the current transaction.Return the R2DBCConnectionFactorythat this instance manages transactions for.booleanReturn whether to enforce the read-only nature of a transaction through an explicit statement on the transactional connection.protected booleanisExistingTransaction(Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).protected ConnectionFactoryObtain theConnectionFactoryfor actual use.protected reactor.core.publisher.Mono<Void>prepareTransactionalConnection(Connection con, TransactionDefinition definition) Prepare the transactionalConnectionright after transaction begin.protected IsolationLevelresolveIsolationLevel(int isolationLevel) Resolve the isolation level constant to a R2DBCIsolationLevel.voidsetConnectionFactory(ConnectionFactory connectionFactory) Set the R2DBCConnectionFactorythat this instance should manage transactions for.voidsetEnforceReadOnly(boolean enforceReadOnly) Specify whether to enforce the read-only nature of a transaction (as indicated byTransactionDefinition.isReadOnly()) through an explicit statement on the transactional connection: "SET TRANSACTION READ ONLY" as understood by Oracle, MySQL and Postgres.protected RuntimeExceptiontranslateException(String task, R2dbcException ex) Translate the given R2DBC commit/rollback exception to a common Spring exception to propagate from theAbstractReactiveTransactionManager.commit(org.springframework.transaction.ReactiveTransaction)/AbstractReactiveTransactionManager.rollback(org.springframework.transaction.ReactiveTransaction)call.Methods inherited from class org.springframework.transaction.reactive.AbstractReactiveTransactionManagercommit, getReactiveTransaction, prepareForCommit, registerAfterCompletionWithExistingTransaction, rollback
- 
Constructor Details- 
R2dbcTransactionManagerpublic R2dbcTransactionManager()Create a newR2dbcTransactionManagerinstance. A ConnectionFactory has to be set to be able to use it.
- 
R2dbcTransactionManagerCreate a newR2dbcTransactionManagerinstance.- Parameters:
- connectionFactory- the R2DBC ConnectionFactory to manage transactions for
 
 
- 
- 
Method Details- 
setConnectionFactorySet the R2DBCConnectionFactorythat this instance should manage transactions for.This will typically be a locally defined ConnectionFactory, for example a connection pool.The ConnectionFactorypassed in here needs to return independentConnections. TheConnections may come from a pool (the typical case), but theConnectionFactorymust not return scopedConnections or the like.- See Also:
 
- 
getConnectionFactoryReturn the R2DBCConnectionFactorythat this instance manages transactions for.
- 
obtainConnectionFactoryObtain theConnectionFactoryfor actual use.- Returns:
- the ConnectionFactory(nevernull)
- Throws:
- IllegalStateException- in case of no ConnectionFactory set
 
- 
setEnforceReadOnlypublic void setEnforceReadOnly(boolean enforceReadOnly) Specify whether to enforce the read-only nature of a transaction (as indicated byTransactionDefinition.isReadOnly()) through an explicit statement on the transactional connection: "SET TRANSACTION READ ONLY" as understood by Oracle, MySQL and Postgres.The exact treatment, including any SQL statement executed on the connection, can be customized through prepareTransactionalConnection(io.r2dbc.spi.Connection, org.springframework.transaction.TransactionDefinition).
- 
isEnforceReadOnlypublic boolean isEnforceReadOnly()Return whether to enforce the read-only nature of a transaction through an explicit statement on the transactional connection.- See Also:
 
- 
afterPropertiesSetpublic void afterPropertiesSet()Description copied from interface:InitializingBeanInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. - Specified by:
- afterPropertiesSetin interface- InitializingBean
 
- 
doGetTransactionprotected Object doGetTransaction(TransactionSynchronizationManager synchronizationManager) throws TransactionException Description copied from class:AbstractReactiveTransactionManagerReturn a transaction object for the current transaction state.The returned object will usually be specific to the concrete transaction manager implementation, carrying corresponding transaction state in a modifiable fashion. This object will be passed into the other template methods (e.g. doBegin and doCommit), either directly or as part of a DefaultReactiveTransactionStatus instance. The returned object should contain information about any existing transaction, that is, a transaction that has already started before the current getTransactioncall on the transaction manager. Consequently, adoGetTransactionimplementation will usually look for an existing transaction and store corresponding state in the returned transaction object.- Specified by:
- doGetTransactionin class- AbstractReactiveTransactionManager
- Parameters:
- synchronizationManager- the synchronization manager bound to the current transaction
- Returns:
- the current transaction object
- Throws:
- CannotCreateTransactionException- if transaction support is not available
- TransactionException- in case of lookup or system errors
- See Also:
- 
- AbstractReactiveTransactionManager.doBegin(org.springframework.transaction.reactive.TransactionSynchronizationManager, java.lang.Object, org.springframework.transaction.TransactionDefinition)
- AbstractReactiveTransactionManager.doCommit(org.springframework.transaction.reactive.TransactionSynchronizationManager, org.springframework.transaction.reactive.GenericReactiveTransaction)
- AbstractReactiveTransactionManager.doRollback(org.springframework.transaction.reactive.TransactionSynchronizationManager, org.springframework.transaction.reactive.GenericReactiveTransaction)
- GenericReactiveTransaction.getTransaction()
 
 
- 
isExistingTransactionDescription copied from class:AbstractReactiveTransactionManagerCheck if the given transaction object indicates an existing transaction (that is, a transaction which has already started).The result will be evaluated according to the specified propagation behavior for the new transaction. An existing transaction might get suspended (in case of PROPAGATION_REQUIRES_NEW), or the new transaction might participate in the existing one (in case of PROPAGATION_REQUIRED). The default implementation returns false, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.- Overrides:
- isExistingTransactionin class- AbstractReactiveTransactionManager
- Parameters:
- transaction- the transaction object returned by doGetTransaction
- Returns:
- if there is an existing transaction
- See Also:
 
- 
doBeginprotected reactor.core.publisher.Mono<Void> doBegin(TransactionSynchronizationManager synchronizationManager, Object transaction, TransactionDefinition definition) throws TransactionException Description copied from class:AbstractReactiveTransactionManagerBegin a new transaction with semantics according to the given transaction definition. Does not have to care about applying the propagation behavior, as this has already been handled by this abstract manager.This method gets called when the transaction manager has decided to actually start a new transaction. Either there wasn't any transaction before, or the previous transaction has been suspended. A special scenario is a nested transaction: This method will be called to start a nested transaction when necessary. In such a context, there will be an active transaction: The implementation of this method has to detect this and start an appropriate nested transaction. - Specified by:
- doBeginin class- AbstractReactiveTransactionManager
- Parameters:
- synchronizationManager- the synchronization manager bound to the new transaction
- transaction- the transaction object returned by- doGetTransaction
- definition- a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name
- Throws:
- TransactionException- in case of creation or system errors
- NestedTransactionNotSupportedException- if the underlying transaction does not support nesting (e.g. through savepoints)
 
- 
createTransactionDefinitionDetermine the transaction definition from ourTransactionDefinition. Can be overridden to wrap the R2DBCTransactionDefinitionto adjust or enhance transaction attributes.- Parameters:
- definition- the transaction definition
- Returns:
- the actual transaction definition to use
- Since:
- 6.0
- See Also:
 
- 
determineTimeoutDetermine the actual timeout to use for the given definition. Will fall back to this manager's default timeout if the transaction definition doesn't specify a non-default value.- Parameters:
- definition- the transaction definition
- Returns:
- the actual timeout to use
- See Also:
 
- 
doSuspendprotected reactor.core.publisher.Mono<Object> doSuspend(TransactionSynchronizationManager synchronizationManager, Object transaction) throws TransactionException Description copied from class:AbstractReactiveTransactionManagerSuspend the resources of the current transaction. Transaction synchronization will already have been suspended.The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported. - Overrides:
- doSuspendin class- AbstractReactiveTransactionManager
- Parameters:
- synchronizationManager- the synchronization manager bound to the current transaction
- transaction- the transaction object returned by- doGetTransaction
- Returns:
- an object that holds suspended resources (will be kept unexamined for passing it into doResume)
- Throws:
- TransactionSuspensionNotSupportedException- if suspending is not supported by the transaction manager implementation
- TransactionException- in case of system errors
- See Also:
 
- 
doResumeprotected reactor.core.publisher.Mono<Void> doResume(TransactionSynchronizationManager synchronizationManager, @Nullable Object transaction, Object suspendedResources) throws TransactionException Description copied from class:AbstractReactiveTransactionManagerResume the resources of the current transaction. Transaction synchronization will be resumed afterwards.The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported. - Overrides:
- doResumein class- AbstractReactiveTransactionManager
- Parameters:
- synchronizationManager- the synchronization manager bound to the current transaction
- transaction- the transaction object returned by- doGetTransaction
- suspendedResources- the object that holds suspended resources, as returned by doSuspend
- Throws:
- TransactionSuspensionNotSupportedException- if suspending is not supported by the transaction manager implementation
- TransactionException- in case of system errors
- See Also:
 
- 
doCommitprotected reactor.core.publisher.Mono<Void> doCommit(TransactionSynchronizationManager TransactionSynchronizationManager, GenericReactiveTransaction status) throws TransactionException Description copied from class:AbstractReactiveTransactionManagerPerform an actual commit of the given transaction.An implementation does not need to check the "new transaction" flag or the rollback-only flag; this will already have been handled before. Usually, a straight commit will be performed on the transaction object contained in the passed-in status. - Specified by:
- doCommitin class- AbstractReactiveTransactionManager
- Parameters:
- TransactionSynchronizationManager- the synchronization manager bound to the current transaction
- status- the status representation of the transaction
- Throws:
- TransactionException- in case of commit or system errors
- See Also:
 
- 
doRollbackprotected reactor.core.publisher.Mono<Void> doRollback(TransactionSynchronizationManager TransactionSynchronizationManager, GenericReactiveTransaction status) throws TransactionException Description copied from class:AbstractReactiveTransactionManagerPerform an actual rollback of the given transaction.An implementation does not need to check the "new transaction" flag; this will already have been handled before. Usually, a straight rollback will be performed on the transaction object contained in the passed-in status. - Specified by:
- doRollbackin class- AbstractReactiveTransactionManager
- Parameters:
- TransactionSynchronizationManager- the synchronization manager bound to the current transaction
- status- the status representation of the transaction
- Throws:
- TransactionException- in case of system errors
- See Also:
 
- 
doSetRollbackOnlyprotected reactor.core.publisher.Mono<Void> doSetRollbackOnly(TransactionSynchronizationManager synchronizationManager, GenericReactiveTransaction status) throws TransactionException Description copied from class:AbstractReactiveTransactionManagerSet the given transaction rollback-only. Only called on rollback if the current transaction participates in an existing one.The default implementation throws an IllegalTransactionStateException, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support. - Overrides:
- doSetRollbackOnlyin class- AbstractReactiveTransactionManager
- Parameters:
- synchronizationManager- the synchronization manager bound to the current transaction
- status- the status representation of the transaction
- Throws:
- TransactionException- in case of system errors
 
- 
doCleanupAfterCompletionprotected reactor.core.publisher.Mono<Void> doCleanupAfterCompletion(TransactionSynchronizationManager synchronizationManager, Object transaction) Description copied from class:AbstractReactiveTransactionManagerCleanup resources after transaction completion.Called after doCommitanddoRollbackexecution, on any outcome. The default implementation does nothing.Should not throw any exceptions but just issue warnings on errors. - Overrides:
- doCleanupAfterCompletionin class- AbstractReactiveTransactionManager
- Parameters:
- synchronizationManager- the synchronization manager bound to the current transaction
- transaction- the transaction object returned by- doGetTransaction
 
- 
prepareTransactionalConnectionprotected reactor.core.publisher.Mono<Void> prepareTransactionalConnection(Connection con, TransactionDefinition definition) Prepare the transactionalConnectionright after transaction begin.The default implementation executes a "SET TRANSACTION READ ONLY" statement if the "enforceReadOnly"flag is set totrueand the transaction definition indicates a read-only transaction.The "SET TRANSACTION READ ONLY" is understood by Oracle, MySQL and Postgres and may work with other databases as well. If you'd like to adapt this treatment, override this method accordingly. - Parameters:
- con- the transactional R2DBC Connection
- definition- the current transaction definition
- Since:
- 5.3.22
- See Also:
 
- 
resolveIsolationLevelResolve the isolation level constant to a R2DBCIsolationLevel. If you'd like to extend isolation level translation for vendor-specificIsolationLevels, override this method accordingly.- Parameters:
- isolationLevel- the isolation level to translate.
- Returns:
- the resolved isolation level. Can be nullif not resolvable or the isolation level should remaindefault.
- See Also:
 
- 
translateExceptionTranslate the given R2DBC commit/rollback exception to a common Spring exception to propagate from theAbstractReactiveTransactionManager.commit(org.springframework.transaction.ReactiveTransaction)/AbstractReactiveTransactionManager.rollback(org.springframework.transaction.ReactiveTransaction)call.- Parameters:
- task- the task description (commit or rollback).
- ex- the SQLException thrown from commit/rollback.
- Returns:
- the translated exception to emit
 
 
-