first draft docs

Author: timgraham

django_mongodb_backend/features.py

@@ -97,7 +97,8 @@ class DatabaseFeatures(BaseDatabaseFeatures):
         "expressions.tests.ExpressionOperatorTests.test_lefthand_transformed_field_bitwise_or",
     }
     _django_test_expected_failures_transactions = {
-        # When get_or_create() fails with IntegrityError, the transaction is no longer usable.
+        # When update_or_create() fails with IntegrityError, the transaction
+        # is no longer usable.
         "get_or_create.tests.UpdateOrCreateTests.test_manual_primary_key_test",
         "get_or_create.tests.UpdateOrCreateTestsWithManualPKs.test_create_with_duplicate_primary_key",
     }

docs/source/conf.py

@@ -45,6 +45,7 @@
     "pymongo": ("https://pymongo.readthedocs.io/en/stable/", None),
     "python": ("https://docs.python.org/3/", None),
     "atlas": ("https://www.mongodb.com/docs/atlas/", None),
+    "manual": ("https://www.mongodb.com/docs/manual/", None),
 }
 
 root_doc = "contents"

docs/source/ref/database.rst

@@ -41,3 +41,39 @@ effect. Rather, if you need to close the connection pool, use
 .. versionadded:: 5.2.0b0
 
     Support for connection pooling and ``connection.close_pool()`` were added.
+
+.. _transactions:
+
+Transactions
+============
+
+.. versionadded:: 5.2.0b2
+
+Support for transactions is enabled if the MongoDB configuration supports them:
+MongoDB must be configured as a :doc:`replica set <manual:replication>` or
+:doc:`sharded cluster <manual:sharding>`, and the store engine must be
+:doc:`WiredTiger <manual:core/wiredtiger>`.
+
+If transactions aren't supported (and for any queries run outside of an
+:func:`~django.db.transaction.atomic` block), query execution uses Django and
+MongoDB's default behavior of autocommit mode. Each query is immediately
+committed to the database.
+
+If transactions aren't supported, Django's :doc:`transaction management APIs
+<django:topics/db/transactions>` function as no-ops.
+
+Limitations
+-----------
+
+MongoDB's transactions have some limitations.
+
+- :meth:`QuerySet.union() <django.db.models.query.QuerySet.union>` is not
+  supported.
+- If a transaction raises an exception, the transaction is no longer usable.
+  For example, if the update stage of :meth:`QuerySet.update_or_create()
+  <django.db.models.query.QuerySet.update_or_create>` fails with
+  :class:`~django.db.IntegrityError` due to a unique constraint violation, the
+  create stage won't be able to proceed.
+  :class:`pymongo.errors.OperationFailure` is raised, wrapped by
+  :class:`django.db.DatabaseError`.
+- Savepoints are not supported.

docs/source/releases/5.2.x.rst

@@ -2,6 +2,16 @@
 Django MongoDB Backend 5.2.x
 ============================
 
+5.2.0 beta 2
+============
+
+*Unreleased*
+
+New features
+------------
+
+- Added support for :ref:`database transactions <transactions>`.
+
 5.2.0 beta 1
 ============
 

docs/source/topics/known-issues.rst

@@ -77,15 +77,6 @@ Database functions
   :class:`~django.db.models.functions.TruncTime` database functions isn't
   supported.
 
-Transaction management
-======================
-
-Query execution uses Django and MongoDB's default behavior of autocommit mode.
-Each query is immediately committed to the database.
-
-Django's :doc:`transaction management APIs <django:topics/db/transactions>`
-are not supported.
-
 Database introspection
 ======================