Skip to content

Commit 7f421db

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

File tree

1 file changed

+18
-64
lines changed

1 file changed

+18
-64
lines changed

source/limitations-upcoming.txt

Lines changed: 18 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -34,26 +34,23 @@ 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 :doc:`transaction management APIs <django:topics/db/transactions>`
53+
are not supported.
5754

5855
.. _django-limitations-models:
5956

@@ -121,7 +118,7 @@ Fields
121118
``$lookup`` operations, see the :atlas:`Reduce $lookup Operations
122119
</schema-suggestions/reduce-lookup-operations/>` guide in the Atlas
123120
documentation.
124-
- Performance of `CASCADE deletes <{+django-docs+}/ref/models/fields/#django.db.models.CASCADE>`__
121+
- Performance of `CASCADE deletes <{+django-docs+}/ref/models/fields/#django.db.models.CASCADE>`__
125122
on a ``ForeignKey`` field is not as performant as using an
126123
``EmbeddedModelField``.
127124

@@ -195,9 +192,6 @@ Django Management Command Limitations
195192

196193
- ``createcachetable``
197194
- ``inspectdb``
198-
- ``optimizemigration``
199-
- ``sqlflush``
200-
- ``sqlsequencereset``
201195

202196
.. _django-limitations-migration:
203197

@@ -213,22 +207,6 @@ Migration Limitations
213207
- `DDL Transactions <{+django-docs+}/topics/migrations/#transactions>`__.
214208
- ``migrate --fake-initial`` command.
215209

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-
232210
.. _django-limitations-performance:
233211

234212
Performance
@@ -245,15 +223,13 @@ General Availability Release Features
245223
-------------------------------------
246224

247225
In this section, you can learn about the following
248-
types of {+framework+} and MongoDB features that
226+
types of {+framework+} and MongoDB features that
249227
GA and post-GA {+django-odm+} releases will likely introduce:
250228

251229
- :ref:`django-upcoming-mongodb`
252230
- :ref:`django-upcoming-models`
253231
- :ref:`django-upcoming-management`
254232
- :ref:`django-upcoming-third-party`
255-
- :ref:`django-upcoming-variables`
256-
- :ref:`django-upcoming-async`
257233

258234
.. _django-upcoming-mongodb:
259235

@@ -311,49 +287,27 @@ the GA release:
311287
- Multiple models within a collection
312288
- Improved form representation in embedded models
313289

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

317293
.. _django-upcoming-management:
318294

319295
Django Management Command Features
320296
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321297

322-
We plan to support the following Django commands in
323-
the GA release:
324-
325-
- ``dumpdata``
326-
- ``loaddata``
298+
Serialization support for ``EmbeddedModelField`` (i.g. Django's `dumpdata`` and
299+
``loaddata`` management commands) will be added by the GA release.
327300

328301
.. _django-upcoming-third-party:
329302

330-
Third Party Features
331-
~~~~~~~~~~~~~~~~~~~~
303+
Third Party Libraries
304+
~~~~~~~~~~~~~~~~~~~~~
332305

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

336309
- `Django-filter <https://django-filter.readthedocs.io/en/stable/>`__
337310
- `Django Rest Framework <https://www.django-rest-framework.org/>`__
338311
- `Django-allauth <https://docs.allauth.org/en/latest/>`__
339312
- `Wagtail <https://wagtail.org/>`__
340313
- `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)