summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorlufafajoshua <77637648+lufafajoshua@users.noreply.github.com>2023-10-27 15:05:31 +0300
committerNatalia <124304+nessita@users.noreply.github.com>2023-10-27 17:35:47 -0300
commitaa80b357fbef46e5b6faa08d63bcfd4fe21f3776 (patch)
treedd8cea0532957e03ab1e9ee65eea6d1590da220f /docs
parent8d9c0e4e244111ea3839434d8812c8573cfbf00e (diff)
Fixed #30601 -- Doc'd the need to manually revert all app state on transaction rollbacks.
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/db/transactions.txt12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/topics/db/transactions.txt b/docs/topics/db/transactions.txt
index 951ce54a68..5306f532f8 100644
--- a/docs/topics/db/transactions.txt
+++ b/docs/topics/db/transactions.txt
@@ -187,7 +187,7 @@ Django provides a single API to control database transactions.
If you catch exceptions raised by raw SQL queries, Django's behavior
is unspecified and database-dependent.
- .. admonition:: You may need to manually revert model state when rolling back a transaction.
+ .. admonition:: You may need to manually revert app state when rolling back a transaction.
The values of a model's fields won't be reverted when a transaction
rollback happens. This could lead to an inconsistent model state unless
@@ -210,6 +210,14 @@ Django provides a single API to control database transactions.
if obj.active:
...
+ This also applies to any other mechanism that may hold app state, such
+ as caching or global variables. For example, if the code proactively
+ updates data in the cache after saving an object, it's recommended to
+ use :ref:`transcation.on_commit <performing-actions-after-commit>`
+ instead, to defer cache alterations until the transaction is actually
+ committed.
+
+
In order to guarantee atomicity, ``atomic`` disables some APIs. Attempting
to commit, roll back, or change the autocommit state of the database
connection within an ``atomic`` block will raise an exception.
@@ -285,6 +293,8 @@ by Django or by third-party libraries. Thus, this is best used in situations
where you want to run your own transaction-controlling middleware or do
something really strange.
+.. _performing-actions-after-commit:
+
Performing actions after commit
===============================