Repository navigation
[8.x] Explain that @Transactional doesn't cover asynchronous database work - #917
Merged
Merged
Conversation
The transaction of a @transactional action gets committed as soon as the action returns its result, and Ebean binds it to the current thread. So database operations that run on another thread don't run in it, and a CompletionStage that fails doesn't roll it back. Document that, and how to run asynchronous database operations in a transaction instead, with DB.executeCall on an execution context for blocking database calls.
Contributor
|
This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@Transactionaldoesn't cover asynchronous database work #916 to8.x.@Transactionalruns the action inDB.executeCall, so its transaction gets committed as soon as the action returns its result, not when that result completes. Ebean binds the transaction to the current thread, so:@Transactionaland the method calls it asynchronouslyCompletionStagethat fails instead, even one that failed already, the transaction gets committedThis documents that limitation in the Javadoc of
@Transactionaland in the "Transactional actions" section of the Ebean docs. It also shows how to run asynchronous database operations in a transaction: withDB.executeCallinside the asynchronous task, on aCustomExecutionContextfor blocking database calls, together with the configuration of its dispatcher. The new snippets compile and run as part of the docs tests.This documentation change leaves the behaviour of
@Transactionalunchanged.The snippets use
javax.injectinstead ofjakarta.inject, as Play 3.0 does.