summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAymeric Augustin <aymeric.augustin@m4x.org>2013-09-22 22:14:17 +0200
committerAymeric Augustin <aymeric.augustin@m4x.org>2013-09-30 09:42:27 +0200
commit728548e483a5a3486939b0c8e62520296587482e (patch)
treeb83663722c2653334085f2b152f8695f88660b8f /docs
parent9595183d03cfd0d94ae2dd506a3d2b86cf5c74a7 (diff)
Fixed #21134 -- Prevented queries in broken transactions.
Squashed commit of the following: commit 63ddb271a44df389b2c302e421fc17b7f0529755 Author: Aymeric Augustin <aymeric.augustin@m4x.org> Date: Sun Sep 29 22:51:00 2013 +0200 Clarified interactions between atomic and exceptions. commit 2899ec299228217c876ba3aa4024e523a41c8504 Author: Aymeric Augustin <aymeric.augustin@m4x.org> Date: Sun Sep 22 22:45:32 2013 +0200 Fixed TransactionManagementError in tests. Previous commit introduced an additional check to prevent running queries in transactions that will be rolled back, which triggered a few failures in the tests. In practice using transaction.atomic instead of the low-level savepoint APIs was enough to fix the problems. commit 4a639b059ea80aeb78f7f160a7d4b9f609b9c238 Author: Aymeric Augustin <aymeric.augustin@m4x.org> Date: Tue Sep 24 22:24:17 2013 +0200 Allowed nesting constraint_checks_disabled inside atomic. Since MySQL handles transactions loosely, this isn't a problem. commit 2a4ab1cb6e83391ff7e25d08479e230ca564bfef Author: Aymeric Augustin <aymeric.augustin@m4x.org> Date: Sat Sep 21 18:43:12 2013 +0200 Prevented running queries in transactions that will be rolled back. This avoids a counter-intuitive behavior in an edge case on databases with non-atomic transaction semantics. It prevents using savepoint_rollback() inside an atomic block without calling set_rollback(False) first, which is backwards-incompatible in tests. Refs #21134. commit 8e3db393853c7ac64a445b66e57f3620a3fde7b0 Author: Aymeric Augustin <aymeric.augustin@m4x.org> Date: Sun Sep 22 22:14:17 2013 +0200 Replaced manual savepoints by atomic blocks. This ensures the rollback flag is handled consistently in internal APIs.
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/db/transactions.txt27
1 files changed, 19 insertions, 8 deletions
diff --git a/docs/topics/db/transactions.txt b/docs/topics/db/transactions.txt
index 1483bddd0b..c7adb9e191 100644
--- a/docs/topics/db/transactions.txt
+++ b/docs/topics/db/transactions.txt
@@ -163,20 +163,31 @@ Django provides a single API to control database transactions.
called, so the exception handler can also operate on the database if
necessary.
- .. admonition:: Don't catch database exceptions inside ``atomic``!
+ .. admonition:: Avoid catching exceptions inside ``atomic``!
- If you catch :exc:`~django.db.DatabaseError` or a subclass such as
- :exc:`~django.db.IntegrityError` inside an ``atomic`` block, you will
- hide from Django the fact that an error has occurred and that the
- transaction is broken. At this point, Django's behavior is unspecified
- and database-dependent. It will usually result in a rollback, which
- may break your expectations, since you caught the exception.
+ When exiting an ``atomic`` block, Django looks at whether it's exited
+ normally or with an exception to determine whether to commit or roll
+ back. If you catch and handle exceptions inside an ``atomic`` block,
+ you may hide from Django the fact that a problem has happened. This
+ can result in unexpected behavior.
+
+ This is mostly a concern for :exc:`~django.db.DatabaseError` and its
+ subclasses such as :exc:`~django.db.IntegrityError`. After such an
+ error, the transaction is broken and Django will perform a rollback at
+ the end of the ``atomic`` block. If you attempt to run database
+ queries before the rollback happens, Django will raise a
+ :class:`~django.db.transaction.TransactionManagementError`. You may
+ also encounter this behavior when an ORM-related signal handler raises
+ an exception.
The correct way to catch database errors is around an ``atomic`` block
as shown above. If necessary, add an extra ``atomic`` block for this
- purpose -- it's cheap! This pattern is useful to delimit explicitly
+ purpose. This pattern has another advantage: it delimits explicitly
which operations will be rolled back if an exception occurs.
+ If you catch exceptions raised by raw SQL queries, Django's behavior
+ is unspecified and database-dependent.
+
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.