Skip to content

Commit e8eda92

Browse files
committed
Correct and copyedit limitations page
1 parent 3cb7ac7 commit e8eda92

File tree

1 file changed

+19
-66
lines changed

1 file changed

+19
-66
lines changed

source/limitations-upcoming.txt

Lines changed: 19 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -34,26 +34,22 @@ Feature Limitations
3434
In this section, you can learn about the following
3535
types of unsupported {+framework+} and MongoDB features:
3636

37-
- :ref:`django-limitations-database`
37+
- :ref:`django-limitations-transactions`
3838
- :ref:`django-limitations-models`
3939
- :ref:`django-limitations-query`
4040
- :ref:`django-limitations-management`
4141
- :ref:`django-limitations-migration`
42-
- :ref:`django-limitations-async`
43-
- :ref:`django-limitations-data`
4442
- :ref:`django-limitations-performance`
4543

46-
.. _django-limitations-database:
44+
.. _django-limitations-transactions:
4745

48-
Unsupported Database Variables
49-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46+
Transaction management
47+
~~~~~~~~~~~~~~~~~~~~~~
5048

51-
The following database variables are not supported by {+django-odm+}:
49+
Query execution uses Django and MongoDB's default behavior of autocommit mode.
50+
Each query is immediately committed to the database.
5251

53-
- ``ATOMIC_REQUESTS``
54-
- ``AUTOCOMMIT``
55-
- ``CONN_HEALTH_CHECKS``
56-
- ``TIME_ZONE``
52+
Django's transaction management APIs are not supported.
5753

5854
.. _django-limitations-models:
5955

@@ -121,7 +117,7 @@ Fields
121117
``$lookup`` operations, see the :atlas:`Reduce $lookup Operations
122118
</schema-suggestions/reduce-lookup-operations/>` guide in the Atlas
123119
documentation.
124-
- Performance of `CASCADE deletes <{+django-docs+}/ref/models/fields/#django.db.models.CASCADE>`__
120+
- Performance of `CASCADE deletes <{+django-docs+}/ref/models/fields/#django.db.models.CASCADE>`__
125121
on a ``ForeignKey`` field is not as performant as using an
126122
``EmbeddedModelField``.
127123

@@ -195,9 +191,6 @@ Django Management Command Limitations
195191

196192
- ``createcachetable``
197193
- ``inspectdb``
198-
- ``optimizemigration``
199-
- ``sqlflush``
200-
- ``sqlsequencereset``
201194

202195
.. _django-limitations-migration:
203196

@@ -213,22 +206,6 @@ Migration Limitations
213206
- `DDL Transactions <{+django-docs+}/topics/migrations/#transactions>`__.
214207
- ``migrate --fake-initial`` command.
215208

216-
.. _django-limitations-async:
217-
218-
Asynchronous Limitations
219-
~~~~~~~~~~~~~~~~~~~~~~~~
220-
221-
{+django-odm+} has not been tested for support of the asynchronous functionality of
222-
the Django API.
223-
224-
.. _django-limitations-data:
225-
226-
Data Types
227-
~~~~~~~~~~
228-
229-
{+django-odm+} does not have a custom ``Field`` class for the ``BSONRegExp``
230-
data type. Instead, use the ``CharField`` class.
231-
232209
.. _django-limitations-performance:
233210

234211
Performance
@@ -245,15 +222,13 @@ General Availability Release Features
245222
-------------------------------------
246223

247224
In this section, you can learn about the following
248-
types of {+framework+} and MongoDB features that
225+
types of {+framework+} and MongoDB features that
249226
GA and post-GA {+django-odm+} releases will likely introduce:
250227

251228
- :ref:`django-upcoming-mongodb`
252229
- :ref:`django-upcoming-models`
253230
- :ref:`django-upcoming-management`
254231
- :ref:`django-upcoming-third-party`
255-
- :ref:`django-upcoming-variables`
256-
- :ref:`django-upcoming-async`
257232

258233
.. _django-upcoming-mongodb:
259234

@@ -311,49 +286,27 @@ the GA release:
311286
- Multiple models within a collection
312287
- Improved form representation in embedded models
313288

314-
In future post-GA releases, we plan to support a custom ``Field``
315-
class for the ``BSONRegExp`` data type.
289+
In future post-GA release, we plan to add a custom model field for the
290+
``BSONRegExp`` data type.
316291

317292
.. _django-upcoming-management:
318293

319-
Django Management Command Features
320-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321-
322-
We plan to support the following Django commands in
323-
the GA release:
294+
Management Command Features
295+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
324296

325-
- ``dumpdata``
326-
- ``loaddata``
297+
Serialization support for ``EmbeddedModelField`` (i.g. Django's `dumpdata`` and
298+
``loaddata`` management commands) will be added by the GA release.
327299

328300
.. _django-upcoming-third-party:
329301

330-
Third Party Features
331-
~~~~~~~~~~~~~~~~~~~~
302+
Third-Party Libraries
303+
~~~~~~~~~~~~~~~~~~~~~
332304

333-
We plan to support the following third-party features in
334-
the GA release:
305+
We plan to test compatibility with the following third-party libraries by the
306+
GA release:
335307

336308
- `Django-filter <https://django-filter.readthedocs.io/en/stable/>`__
337309
- `Django Rest Framework <https://www.django-rest-framework.org/>`__
338310
- `Django-allauth <https://docs.allauth.org/en/latest/>`__
339311
- `Wagtail <https://wagtail.org/>`__
340312
- `Django Debug Toolbar <https://django-debug-toolbar.readthedocs.io/en/latest/>`__
341-
342-
.. _django-upcoming-variables:
343-
344-
Database Variable Support
345-
~~~~~~~~~~~~~~~~~~~~~~~~~
346-
347-
We plan to support the following Django variables for configuring
348-
your database connection in future post-GA releases:
349-
350-
- ``CONN_HEALTH_CHECKS``
351-
- ``TIME_ZONE``
352-
353-
.. _django-upcoming-async:
354-
355-
Asynchronous Support
356-
~~~~~~~~~~~~~~~~~~~~
357-
358-
We plan to offer asynchronous support for {+django-odm+} in
359-
future post-GA releases.

0 commit comments

Comments
 (0)