From 0d169383172316bc2146cc1d8557a4d855cdcc23 Mon Sep 17 00:00:00 2001 From: norareidy Date: Fri, 14 Mar 2025 11:19:42 -0400 Subject: [PATCH 01/19] DOCSP-48184: Rework limitations and upcoming --- source/feature-compatibility.txt | 440 +++++++++++++++++++++++++++++++ source/index.txt | 2 +- source/limitations-upcoming.txt | 301 --------------------- 3 files changed, 441 insertions(+), 302 deletions(-) create mode 100644 source/feature-compatibility.txt delete mode 100644 source/limitations-upcoming.txt diff --git a/source/feature-compatibility.txt b/source/feature-compatibility.txt new file mode 100644 index 0000000..a32f809 --- /dev/null +++ b/source/feature-compatibility.txt @@ -0,0 +1,440 @@ +.. _django-limitations: +.. _django-feature-compat: + +======================================== +Django and MongoDB Feature Compatibility +======================================== + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: upcoming, odm, support + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +Overview +-------- + +On this page, you can find information about supported and unsupported +features in {+django-odm+}. You can also find features +currently planned for the General Availability (GA) and post-GA +releases. We will prioritize these upcoming features +based on user demand, and you can request support +for a feature by :ref:`creating a JIRA issue `. + +MongoDB Features +---------------- + +This section indicates whether the {+django-odm+} supports various +MongoDB features and which features we plan to support in +the GA release. + +Index Support +~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - MongoDB Feature + - Public Preview Support + - General Availability Support + + * - Atlas Search and Atlas Vector Search indexes + - *Partially Supported*. You cannot use the Django + Indexes API to create these indexes, but you can use + the PyMongo Driver by :ref:`exposing your MongoClient `. + - ✓ + + * - Geospatial indexes + - *Partially Supported*. You cannot use the Django + Indexes API to create these indexes, but you can use + the PyMongo Driver by :ref:`exposing your MongoClient `. + - ✓ + + * - Updating ``EmbeddedModelFields`` indexes after model creation + - *Unsupported* + - ✓ + +Field Type Support +~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - MongoDB Field Type + - Public Preview Support + - General Availability Support + + * - ``Array`` + - *Partially Supported*. You can use the ``ArrayField`` field type with the + following limitations: + + - ``ArrayField`` polymorphism is not supported. + - Nested ``EmbeddedModelField`` values within an ``ArrayField`` are not supported. + + - ✓ + + * - ``Object`` + - *Partially Supported*. You can use the ``EmbeddedModelField`` field type with the + following limitations: + + - ``EmbeddedModel`` schema changes do not register after creation. + - Embedded documents cannot take Django foreign keys. + - Arbitrary or untyped embedded model fields are not supported. You must + derive all fields from a ``EmbeddedModel`` class. + + - *Partial Support Planned*. We plan to add support for registering + ``EmbeddedModel`` schema changes after creation. + +{+django-odm+} currently supports all other MongoDB field types not included +in the preceding table. To view a full list of supported fields, see the :ref:`django-models-mongodb-fields` +section of the Create Models guide. + +Query Support +~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - MongoDB Feature + - Public Preview Support + - General Availability Support + + * - Aggregation operations + - *Partially Supported*. The {+django-odm+} does not include custom + Django field lookups for the MongoDB aggregation framework, but you + can use the :ref:`raw_aggregate() method `. + - *Full Support Not Planned*. However, we plan to add support for MongoDB + aggregation operators in a post-GA release. + + * - Atlas Search queries + - *Partially Supported*. You cannot use the Django + ``QuerySet`` API to run Atlas Search queries, but you can use + the :ref:`raw_aggregate() method `. + - ✓ + + * - Geospatial queries + - *Partially Supported*. You cannot use the Django + ``QuerySet`` or ``GeoDjango`` API to run geospatial queries, but you can use + the :ref:`raw_aggregate() method `. + - ✓ + + * - Vector Search queries + - *Partially Supported*. You cannot use the Django + ``QuerySet`` API to run Vector Search queries, but you can use + the :ref:`raw_aggregate() method `. + - ✓ + +Database and Collection Support +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - MongoDB Feature + - Public Preview Support + - General Availability Support + + * - Transactions + - *Unsupported*. + - ✓ + + * - Encryption: Client-side Field Level Encryption and Queryable Encryption + - *Unsupported*. + - ✓ + + * - Multiple models for one collection + - *Unsupported*. + - ✓ + + * - GridFS + - *Unsupported*. + - *Unsupported*. However, we plan to add support for this feature + in a post-GA release. + + * - Change Streams + - *Unsupported*. + - *Unsupported*. However, we plan to add support for this feature + in a post-GA release. + + * - Schema Validation + - *Unsupported*. + - *Unsupported*. However, we plan to add support for this feature + in a post-GA release. + + * - Cached data storage + - *Unsupported*. + - ✓ + +Django Features +--------------- + +This section indicates whether the {+django-odm+} supports various +{+framework+} features and which features we plan to support in +the GA release. + +Field Type Support +~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - {+framework+} Field Type + - Public Preview Support + - General Availability Support + + * - ``AutoField`` + - *Unsupported*. The ``BigAutoField`` and ``SmallAutoField`` types are also + not supported. Instead, use ``ObjectIdField``. + - *Unsupported*. + + * - ``BSONRegExp`` + - *Unsupported*. + - *Unsupported*. However, we plan to support this field + in a post-GA release. + + * - ``DateTimeField`` + - *Partially Supported*. You can use this field type with the + following limitations: + + - Microsecond granularity for ``DateTimeField`` values is not supported. + + - *Full Support Not Planned*. + + * - ``DurationField`` + - *Partially Supported*. You can use this field type with the + following limitations: + + - ``DurationField`` stores milliseconds rather than microseconds + + - *Full Support Not Planned*. + + * - ``ForeignKey`` + - *Partially Supported*. You can use this field type with the + following limitations: + + - When possible, you should use an ``EmbeddedModelField`` instead of a + ``ForeignKey`` field to avoid using ``$lookup`` operations. An + ``EmbeddedModelField`` emulates a MongoDB embedded document and performs + better than a ``ForeignKey`` field. To learn more about how to reduce + ``$lookup`` operations, see the :atlas:`Reduce $lookup Operations + ` guide in the Atlas + documentation. + - Performance of `CASCADE deletes <{+django-docs+}/ref/models/fields/#django.db.models.CASCADE>`__ + on a ``ForeignKey`` field is not as performant as using an + ``EmbeddedModelField``. + + - *Full Support Not Planned*. + + * - ``GeneratedField`` + - *Unsupported*. + - *Unsupported*. + + * - ``JSONField`` + - *Partially Supported*. You can use this field type with the + following limitations: + + - {+django-odm+} cannot distinguish between a JSON and a SQL ``null`` value. + Queries that use ``Value(None, JSONField())`` or the ``isnull`` lookup + return both JSON and SQL ``null`` values. + - Some queries with ``Q`` objects, such as ``Q(value__foo="bar")``, might + not work as expected. + - Filtering for ``None`` values incorrectly returns objects in which a field + does not exist. + + - *Full Support Not Planned*. However, we plan to address the + ``Q`` object and ``None`` key filtering limitations in a post-GA release. + +{+django-odm+} currently supports all other {+framework+} field types not included in +the preceding table. To view a full list of supported fields, see the :ref:`django-models-django-fields` +section of the Create Models guide. + +Query Support +~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - {+framework+} ``QuerySet`` Method + - Public Preview Support + - General Availability Support + + * - ``dates()`` + - *Unsupported*. + - *Unsupported*. + + * - ``datetimes()`` + - *Unsupported*. + - *Unsupported*. + + * - ``delete()`` + - *Partially Supported*. You cannot use this method to perform + queries that span multiple collections. + - *Full Support Not Planned*. + + * - ``distinct()`` + - *Unsupported*. + - *Unsupported*. + + * - ``extra()`` + - *Unsupported*. + - *Unsupported*. + + * - ``prefetch_related()`` + - *Unsupported*. + - *Unsupported*. + + * - ``update()`` + - *Partially Supported*. You cannot use this method to perform + queries that span multiple collections. + - *Full Support Not Planned*. + +Database Function Support +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - {+framework+} Function + - Public Preview Support + - General Availability Support + + * - ``Chr`` + - *Unsupported*. + - *Unsupported*. + + * - ``ExtractQuarter`` + - *Unsupported*. + - *Unsupported*. + + * - ``MD5`` + - *Unsupported*. + - *Unsupported*. + + * - ``Now`` + - *Unsupported*. + - *Unsupported*. + + * - ``Ord`` + - *Unsupported*. + - *Unsupported*. + + * - ``Pad`` + - *Unsupported*. + - *Unsupported*. + + * - ``Repeat`` + - *Unsupported*. + - *Unsupported*. + + * - ``Reverse`` + - *Unsupported*. + - *Unsupported*. + + * - ``Right`` + - *Unsupported*. + - *Unsupported*. + + * - ``SHA1``, ``SHA224``, ``SHA256``, ``SHA384``, ``SHA512`` + - *Unsupported*. + - *Unsupported*. + + * - ``Sign`` + - *Unsupported*. + - *Unsupported*. + + * - ``Trunc`` + - *Partially Supported*. The ``tzinfo`` parameter doesn't work + properly because MongoDB converts the result back to UTC. + - *Full Support Not Planned*. + +Management Command Support +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - {+framework+} Admin Command + - Public Preview Support + - General Availability Support + + * - ``createcachetable`` + - *Unsupported*. + - *Unsupported*. + + * - ``dumpdata`` + - *Unsupported*. + - ✓ + + * - ``inspectdb`` + - *Unsupported*. + - *Unsupported*. However, we plan to support this command + in a post-GA release. + + * - ``loaddata`` + - *Unsupported*. + - ✓ + +Migration Support +~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - {+framework+} Feature + - Public Preview Support + - General Availability Support + + * - `DDL Transactions <{+django-docs+}/topics/migrations/#transactions>`__ + - *Unsupported*. + - *Unsupported*. + + * - ``migrate --fake-initial`` option + - *Unsupported*. + - *Unsupported*. + +Third Party Library Support +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - Library + - Public Preview Support + - General Availability Support + + * - `Django-filter `__ + - *Unsupported*. + - ✓ + + * - `Django Rest Framework `__ + - *Unsupported*. + - ✓ + + * - `Django-allauth `__ + - *Unsupported*. + - ✓ + + * - `Wagtail `__ + - *Unsupported*. + - ✓ + + * - `Django Debug Toolbar `__ + - *Unsupported*. + - ✓ diff --git a/source/index.txt b/source/index.txt index df10007..88e9250 100644 --- a/source/index.txt +++ b/source/index.txt @@ -15,7 +15,7 @@ Django MongoDB Backend Connection Configuration Model Your Data Interact with Data - Limitations & Upcoming Features + Django & MongoDB Feature Compatibility Issues & Help Compatibility API Documentation <{+api+}> diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt deleted file mode 100644 index 1707f70..0000000 --- a/source/limitations-upcoming.txt +++ /dev/null @@ -1,301 +0,0 @@ -.. _django-limitations: - -================================= -Limitations and Upcoming Features -================================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. facet:: - :name: genre - :values: reference - -.. meta:: - :keywords: support, features, django - -Overview --------- - -On this page, you can find a list of features that -{+django-odm+} does not support. You can also find features -currently planned for the General Availability (GA) and post-GA -releases. We will prioritize these upcoming features -based on user demand, and you can request support -for a feature by :ref:`creating a JIRA issue `. - -Feature Limitations -------------------- - -In this section, you can learn about the following -types of unsupported {+framework+} and MongoDB features: - -- :ref:`django-limitations-transactions` -- :ref:`django-limitations-models` -- :ref:`django-limitations-query` -- :ref:`django-limitations-management` -- :ref:`django-limitations-migration` -- :ref:`django-limitations-performance` - -.. _django-limitations-transactions: - -Transaction management -~~~~~~~~~~~~~~~~~~~~~~ - -Query execution uses Django and MongoDB's default behavior of autocommit mode. -Each query is immediately committed to the database. - -Django's transaction management APIs are not supported. - -.. _django-limitations-models: - -Model Limitations -~~~~~~~~~~~~~~~~~ - -Django doesn't support MongoDB's `polymorphic pattern -`__ -where slightly different models share the same collection. - -Indexes -``````` - -{+django-odm+} does not support the following index functionalities: - -- Creating ``$vectorSearch`` and ``$search`` indexes through the Django - Indexes API -- Creating geospatial indexes through the Django Indexes API -- Updating indexes in ``EmbeddedModelFields`` after model creation - -.. _django-limitations-models-fields: - -Fields -`````` - -{+django-odm+} has the following limitations on the specified field types: - -- ``ArrayField`` - - - ``ArrayField`` polymorphism is not supported. - - Nested ``EmbeddedModelField`` values within an ``ArrayField`` are not supported. - -- ``EmbeddedModelField`` - - - ``EmbeddedModel`` schema changes do not register after creation. - - Embedded documents cannot take Django foreign keys. - - Arbitrary or untyped embedded model fields are not supported. You must - derive all fields from a ``EmbeddedModel`` class. - -- ``JSONField`` - - - {+django-odm+} cannot distinguish between a JSON and a SQL ``null`` value. - Queries that use ``Value(None, JSONField())`` or the ``isnull`` lookup - return both JSON and SQL ``null`` values. - - Some queries with ``Q`` objects, such as ``Q(value__foo="bar")``, might - not work as expected. - - Filtering for ``None`` values incorrectly returns objects in which a field - does not exist. - -- ``DateTimeField`` - - - Microsecond granularity for ``DateTimeField`` values is not supported. - -- ``DurationField`` - - - ``DurationField`` stores milliseconds rather than microseconds. - -- ``ForeignKey`` - - - When possible, you should use an ``EmbeddedModelField`` instead of a - ``ForeignKey`` field to avoid using ``$lookup`` operations. An - ``EmbeddedModelField`` emulates a MongoDB embedded document and performs - better than a ``ForeignKey`` field. To learn more about how to reduce - ``$lookup`` operations, see the :atlas:`Reduce $lookup Operations - ` guide in the Atlas - documentation. - - Performance of `CASCADE deletes <{+django-docs+}/ref/models/fields/#django.db.models.CASCADE>`__ - on a ``ForeignKey`` field is not as performant as using an - ``EmbeddedModelField``. - -The following field types are unavailable in {+django-odm+}: - -- ``GeneratedField`` -- ``AutoField`` (including ``BigAutoField`` and ``SmallAutoField``) - -.. _django-limitations-query: - -Querying Limitations -~~~~~~~~~~~~~~~~~~~~ - -{+django-odm+} does not support the following ``QuerySet`` API methods: - -- ``distinct()`` -- ``dates()`` -- ``datetimes()`` -- ``prefetch_related()`` -- ``extra()`` - -{+django-odm+} does not support ``QuerySet.delete()`` and ``update()`` queries -that span multiple collections. - -Geospatial Queries -`````````````````` - -{+django-odm+} does not support the following geospatial query features: - -- ``GeoDjango`` -- Django lookup operators for MongoDB-specific geospatial queries - -Aggregation Operators -````````````````````` - -{+django-odm+} does not include any custom Django field lookups for the MongoDB -aggregation framework. Instead, use the ``raw_aggregate()`` method. See the -:ref:`django-raw-queries` guide. - -Database Functions -`````````````````` - -{+django-odm+} does not support the following database functions: - -- ``Chr`` -- ``ExtractQuarter`` -- ``MD5`` -- ``Now`` -- ``Ord`` -- ``Pad`` -- ``Repeat`` -- ``Reverse`` -- ``Right`` -- ``SHA1``, ``SHA224``, ``SHA256``, ``SHA384``, ``SHA512`` -- ``Sign`` - -The ``tzinfo`` parameter of the ``Trunc`` database functions doesn't work -properly because MongoDB converts the result back to UTC. - -.. _django-limitations-management: - -Unsupported Management Commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following ``django-admin`` commands are unsupported: - -- ``createcachetable`` -- ``inspectdb`` - -.. _django-limitations-migration: - -Migration Limitations -~~~~~~~~~~~~~~~~~~~~~ - -{+django-odm+} does not support the following migration features: - -- Enforced schema validation. To learn how to enforce schema - validation in your application, see the :manual:`Specify JSON - Schema Validation ` guide in the - {+mdb-server+} manual. -- `DDL Transactions <{+django-docs+}/topics/migrations/#transactions>`__. -- The ``migrate --fake-initial`` option. - -.. _django-limitations-performance: - -Performance -~~~~~~~~~~~ - -The engineering team is prioritizing feature development for the Public Preview -release of {+django-odm+}. Because of this, you might notice performance -limitations with certain workloads. If you encounter any performance issues, -please report them as shown in the :ref:`Issues & Help ` -guide. - -General Availability Release Features -------------------------------------- - -In this section, you can learn about the following -types of {+framework+} and MongoDB features that -GA and post-GA {+django-odm+} releases will likely introduce: - -- :ref:`django-upcoming-mongodb` -- :ref:`django-upcoming-models` -- :ref:`django-upcoming-management` -- :ref:`django-upcoming-third-party` - -.. _django-upcoming-mongodb: - -MongoDB Features -~~~~~~~~~~~~~~~~ - -We plan to support the following MongoDB features in the GA release: - -- Programmatic management of Vector Search, Atlas Search, - and geospatial indexes by using the Django API -- Vector Search, Atlas Search, and geospatial queries - by using the Django API -- Queryable Encryption and Client-side Field Level Encryption -- Database transactions -- Storage of cached data in the database - -We plan to support the following MongoDB features in future post-GA releases: - -- GridFS for large file storage -- Change streams for data monitoring -- Schema validation - -.. tip:: - - To learn more about the MongoDB features mentioned in this section, see - the following resources: - - - :atlas:`Atlas Vector Search ` in the Atlas documentation - - :atlas:`Atlas Search ` in the Atlas documentation - - :manual:`Geospatial Queries ` in the {+mdb-server+} - manual - - :manual:`In-Use Encryption ` in the {+mdb-server+} - manual - - :manual:`Transactions ` in the {+mdb-server+} - manual - - :manual:`GridFS ` in the {+mdb-server+} - manual - - :manual:`Change Streams ` in the {+mdb-server+} - manual - -.. _django-upcoming-models: - -Model Features -~~~~~~~~~~~~~~ - -We plan to support the following model features in the GA release: - -- Arrays of embedded documents -- Polymorphic embedded documents and arrays -- Application of changes to the embedded model schema to - ``EmbeddedModelField`` values -- Multiple models within a collection -- Improved form representation in embedded models - -In a future post-GA release, we plan to add a custom model field for the -``BSONRegExp`` data type. - -.. _django-upcoming-management: - -Management Command Features -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Serialization support for ``EmbeddedModelField`` (i.e. Django's ``dumpdata`` -and ``loaddata`` management commands) will be added by the GA release. - -.. _django-upcoming-third-party: - -Third-Party Libraries -~~~~~~~~~~~~~~~~~~~~~ - -We plan to test compatibility with the following third-party libraries by the -GA release: - -- `Django-filter `__ -- `Django Rest Framework `__ -- `Django-allauth `__ -- `Wagtail `__ -- `Django Debug Toolbar `__ From 33d7ca68bc16c8a13db2f58ee4352e549f7e38e8 Mon Sep 17 00:00:00 2001 From: norareidy Date: Mon, 17 Mar 2025 10:36:19 -0400 Subject: [PATCH 02/19] edits --- source/index.txt | 2 +- ...atibility.txt => limitations-upcoming.txt} | 67 ++++++++++--------- 2 files changed, 35 insertions(+), 34 deletions(-) rename source/{feature-compatibility.txt => limitations-upcoming.txt} (90%) diff --git a/source/index.txt b/source/index.txt index 88e9250..df10007 100644 --- a/source/index.txt +++ b/source/index.txt @@ -15,7 +15,7 @@ Django MongoDB Backend Connection Configuration Model Your Data Interact with Data - Django & MongoDB Feature Compatibility + Limitations & Upcoming Features Issues & Help Compatibility API Documentation <{+api+}> diff --git a/source/feature-compatibility.txt b/source/limitations-upcoming.txt similarity index 90% rename from source/feature-compatibility.txt rename to source/limitations-upcoming.txt index a32f809..7a775b4 100644 --- a/source/feature-compatibility.txt +++ b/source/limitations-upcoming.txt @@ -1,9 +1,8 @@ .. _django-limitations: -.. _django-feature-compat: -======================================== -Django and MongoDB Feature Compatibility -======================================== +================================= +Limitations and Upcoming Features +================================= .. facet:: :name: genre @@ -21,8 +20,8 @@ Django and MongoDB Feature Compatibility Overview -------- -On this page, you can find information about supported and unsupported -features in {+django-odm+}. You can also find features +On this page, you can find information about the feature support +limitations of {+django-odm+}. You can also find features currently planned for the General Availability (GA) and post-GA releases. We will prioritize these upcoming features based on user demand, and you can request support @@ -31,12 +30,13 @@ for a feature by :ref:`creating a JIRA issue `. MongoDB Features ---------------- -This section indicates whether the {+django-odm+} supports various -MongoDB features and which features we plan to support in -the GA release. +This section describes MongoDB features that are unsupported or +partially supported in the the Public Preview release of {+django-odm+}. +Each table indicates whether we plan to support these features +in the GA release. -Index Support -~~~~~~~~~~~~~ +Index Limitations +~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -62,8 +62,8 @@ Index Support - *Unsupported* - ✓ -Field Type Support -~~~~~~~~~~~~~~~~~~ +Field Type Limitations +~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -98,8 +98,8 @@ Field Type Support in the preceding table. To view a full list of supported fields, see the :ref:`django-models-mongodb-fields` section of the Create Models guide. -Query Support -~~~~~~~~~~~~~ +Query Limitations +~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -134,8 +134,8 @@ Query Support the :ref:`raw_aggregate() method `. - ✓ -Database and Collection Support -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Database and Collection Limitations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -149,7 +149,7 @@ Database and Collection Support - *Unsupported*. - ✓ - * - Encryption: Client-side Field Level Encryption and Queryable Encryption + * - Client-side Field Level Encryption and Queryable Encryption - *Unsupported*. - ✓ @@ -179,12 +179,13 @@ Database and Collection Support Django Features --------------- -This section indicates whether the {+django-odm+} supports various -{+framework+} features and which features we plan to support in -the GA release. +This section describes {+framework+} features that are unsupported or +partially supported in the the Public Preview release of {+django-odm+}. +Each table indicates whether we plan to support these features +in the GA release. -Field Type Support -~~~~~~~~~~~~~~~~~~ +Field Type Limitations +~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -260,8 +261,8 @@ Field Type Support the preceding table. To view a full list of supported fields, see the :ref:`django-models-django-fields` section of the Create Models guide. -Query Support -~~~~~~~~~~~~~ +Query Limitations +~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -301,8 +302,8 @@ Query Support queries that span multiple collections. - *Full Support Not Planned*. -Database Function Support -~~~~~~~~~~~~~~~~~~~~~~~~~ +Database Function Limitations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -361,8 +362,8 @@ Database Function Support properly because MongoDB converts the result back to UTC. - *Full Support Not Planned*. -Management Command Support -~~~~~~~~~~~~~~~~~~~~~~~~~~ +Management Command Limitations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -389,8 +390,8 @@ Management Command Support - *Unsupported*. - ✓ -Migration Support -~~~~~~~~~~~~~~~~~ +Migration Limitations +~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -408,8 +409,8 @@ Migration Support - *Unsupported*. - *Unsupported*. -Third Party Library Support -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Third Party Library Limitations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 From ba1beb86a009b595b900cfab4273829e9b6ef618 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 19 Mar 2025 11:11:03 -0400 Subject: [PATCH 03/19] edits to include support --- source/limitations-upcoming.txt | 393 +++++++++++++++++++++++++++++--- 1 file changed, 358 insertions(+), 35 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 7a775b4..e32795b 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -1,8 +1,9 @@ .. _django-limitations: +.. _django-feature-compat: -================================= -Limitations and Upcoming Features -================================= +======================================== +Django and MongoDB Feature Compatibility +======================================== .. facet:: :name: genre @@ -20,23 +21,28 @@ Limitations and Upcoming Features Overview -------- -On this page, you can find information about the feature support -limitations of {+django-odm+}. You can also find features +On this page, you can find information about supported and unsupported +features in {+django-odm+}. You can also find features currently planned for the General Availability (GA) and post-GA releases. We will prioritize these upcoming features based on user demand, and you can request support for a feature by :ref:`creating a JIRA issue `. +.. important:: + + Unsupported features that have a checkmark (``✓``) symbol in the + ``General Availability Support`` column are planned for the GA + release. However, support is not guaranteed. + MongoDB Features ---------------- -This section describes MongoDB features that are unsupported or -partially supported in the the Public Preview release of {+django-odm+}. -Each table indicates whether we plan to support these features -in the GA release. +This section indicates whether the {+django-odm+} supports various +MongoDB features and which features we plan to support in +the GA release. -Index Limitations -~~~~~~~~~~~~~~~~~ +Index Support +~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -52,18 +58,42 @@ Index Limitations the PyMongo Driver by :ref:`exposing your MongoClient `. - ✓ + * - Compound indexes + - ✓ + - ✓ + + * - Embedded document indexes + - ✓ + - ✓ + * - Geospatial indexes - *Partially Supported*. You cannot use the Django Indexes API to create these indexes, but you can use the PyMongo Driver by :ref:`exposing your MongoClient `. - ✓ + * - Multikey indexes + - ✓ + - ✓ + + * - Partial indexes + - ✓ + - ✓ + + * - Single field indexes + - ✓ + - ✓ + + * - Unique indexes + - ✓ + - ✓ + * - Updating ``EmbeddedModelFields`` indexes after model creation - *Unsupported* - ✓ -Field Type Limitations -~~~~~~~~~~~~~~~~~~~~~~ +Field Type Support +~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -98,8 +128,8 @@ Field Type Limitations in the preceding table. To view a full list of supported fields, see the :ref:`django-models-mongodb-fields` section of the Create Models guide. -Query Limitations -~~~~~~~~~~~~~~~~~ +Query Support +~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -122,20 +152,36 @@ Query Limitations the :ref:`raw_aggregate() method `. - ✓ + * - Delete operations + - ✓ Use ``delete()``. + - ✓ + * - Geospatial queries - *Partially Supported*. You cannot use the Django ``QuerySet`` or ``GeoDjango`` API to run geospatial queries, but you can use the :ref:`raw_aggregate() method `. - ✓ + * - Insert operations + - ✓ Use ``create()`` or ``save()``. + - ✓ + + * - Read operations + - ✓ Use ``filter()`` or ``get()``. + - ✓ + + * - Update operations + - ✓ Use ``update()``. + - ✓ + * - Vector Search queries - *Partially Supported*. You cannot use the Django ``QuerySet`` API to run Vector Search queries, but you can use the :ref:`raw_aggregate() method `. - ✓ -Database and Collection Limitations -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Database and Collection Support +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -145,6 +191,18 @@ Database and Collection Limitations - Public Preview Support - General Availability Support + * - Asynchronous support + - *Unsupported*. + - ✓ + + * - Collection interaction + - ✓ Use Django models to represent MongoDB collections. + - ✓ + + * - Database interaction + - ✓ + - ✓ + * - Transactions - *Unsupported*. - ✓ @@ -167,7 +225,7 @@ Database and Collection Limitations - *Unsupported*. However, we plan to add support for this feature in a post-GA release. - * - Schema Validation + * - Schema validation - *Unsupported*. - *Unsupported*. However, we plan to add support for this feature in a post-GA release. @@ -179,13 +237,12 @@ Database and Collection Limitations Django Features --------------- -This section describes {+framework+} features that are unsupported or -partially supported in the the Public Preview release of {+django-odm+}. -Each table indicates whether we plan to support these features -in the GA release. +This section indicates whether the {+django-odm+} supports various +{+framework+} features and which features we plan to support in +the GA release. -Field Type Limitations -~~~~~~~~~~~~~~~~~~~~~~ +Field Type Support +~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -261,17 +318,61 @@ Field Type Limitations the preceding table. To view a full list of supported fields, see the :ref:`django-models-django-fields` section of the Create Models guide. -Query Limitations -~~~~~~~~~~~~~~~~~ +Query Support +~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 30 30 40 - * - {+framework+} ``QuerySet`` Method + * - {+framework+} ``QuerySet`` Feature - Public Preview Support - General Availability Support + * - ``aggregate()`` + - ✓ + - ✓ + + * - ``all()`` + - ✓ + - ✓ + + * - ``alias()`` + - ✓ + - ✓ + + * - ``AND`` operator (``&``) + - ✓ + - ✓ + + * - ``annotate()`` + - ✓ + - ✓ + + * - ``as_manager()`` + - ✓ + - ✓ + + * - ``bulk_create()`` + - ✓ + - ✓ + + * - ``bulk_update()`` + - *Unsupported*. + - *Unsupported*. + + * - ``count()`` + - ✓ + - ✓ + + * - ``contains()`` + - ✓ + - ✓ + + * - ``create()`` + - ✓ + - ✓ + * - ``dates()`` - *Unsupported*. - *Unsupported*. @@ -280,30 +381,143 @@ Query Limitations - *Unsupported*. - *Unsupported*. + * - ``defer()`` + - ✓ + - ✓ + * - ``delete()`` - *Partially Supported*. You cannot use this method to perform queries that span multiple collections. - *Full Support Not Planned*. + * - ``difference()`` + - ✓ + - ✓ + * - ``distinct()`` - *Unsupported*. - *Unsupported*. + * - ``earliest()`` + - ✓ + - ✓ + + * - ``exclude()`` + - ✓ + - ✓ + + * - ``exists()`` + - ✓ + - ✓ + + * - ``explain()`` + - ✓ + - ✓ + * - ``extra()`` - *Unsupported*. - *Unsupported*. + * - ``filter()`` + - ✓ + - ✓ + + * - ``first()`` + - ✓ + - ✓ + + * - ``get()`` + - ✓ + - ✓ + + * - ``get_or_create()`` + - ✓ + - ✓ + + * - ``in_bulk()`` + - ✓ + - ✓ + + * - ``intersection()`` + - ✓ + - ✓ + + * - ``last()`` + - ✓ + - ✓ + + * - ``latest()`` + - ✓ + - ✓ + + * - ``none()`` + - ✓ + - ✓ + + * - ``only()`` + - ✓ + - ✓ + + * - ``OR`` operator (``|``) + - ✓ + - ✓ + + * - ``order_by()`` + - ✓ + - ✓ + * - ``prefetch_related()`` - *Unsupported*. - *Unsupported*. + * - ``raw()`` + - *Unsupported*. However, you can use the ``raw_aggregate()`` method + to run queries that use MongoDB's aggregation pipeline syntax. + - *Unsupported*. + + * - ``reverse()`` + - ✓ + - ✓ + + * - ``union()`` + - ✓ + - ✓ + * - ``update()`` - *Partially Supported*. You cannot use this method to perform queries that span multiple collections. - *Full Support Not Planned*. -Database Function Limitations -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + * - ``update_or_create()`` + - ✓ + - ✓ + + * - ``using()`` + - ✓ + - ✓ + + * - ``select_for_update()`` + - ✓ + - ✓ + + * - ``select_related()`` + - ✓ + - ✓ + + * - ``values()`` + - ✓ + - ✓ + + * - ``values_list()`` + - ✓ + - ✓ + + * - ``XOR`` operator (``^``) + - ✓ + - ✓ + +Database Function Support +~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -362,8 +576,15 @@ Database Function Limitations properly because MongoDB converts the result back to UTC. - *Full Support Not Planned*. -Management Command Limitations -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Management Support +~~~~~~~~~~~~~~~~~~ + +{+django-odm+} supports the {+framework+} Admin interface, which +you can use as a management tool. To learn more, see the :ref:`django-get-started-create-admin` +step in the Get Started guide. + +The following table describes {+django-odm+}'s support for +{+framework+} management commands: .. list-table:: :header-rows: 1 @@ -373,14 +594,34 @@ Management Command Limitations - Public Preview Support - General Availability Support + * - ``check`` + - ✓ + - ✓ + + * - ``compilemessages`` + - ✓ + - ✓ + * - ``createcachetable`` - *Unsupported*. - *Unsupported*. + * - ``dbshell`` + - ✓ + - ✓ + + * - ``diffsettings`` + - ✓ + - ✓ + * - ``dumpdata`` - *Unsupported*. - ✓ + * - ``flush`` + - ✓ + - ✓ + * - ``inspectdb`` - *Unsupported*. - *Unsupported*. However, we plan to support this command @@ -390,8 +631,72 @@ Management Command Limitations - *Unsupported*. - ✓ -Migration Limitations -~~~~~~~~~~~~~~~~~~~~~ + * - ``makemessages`` + - ✓ + - ✓ + + * - ``makemigrations`` + - ✓ + - ✓ + + * - ``migrate`` + - ✓ + - ✓ + + * - ``optimizemigration`` + - ✓ + - ✓ + + * - ``runserver`` + - ✓ + - ✓ + + * - ``sendtestemail`` + - ✓ + - ✓ + + * - ``shell`` + - ✓ + - ✓ + + * - ``showmigrations`` + - ✓ + - ✓ + + * - ``sqlflush`` + - *Unsupported*. + - *Unsupported*. + + * - ``sqlmigrate`` + - ✓ + - ✓ + + * - ``sqlsequencereset`` + - *Unsupported*. + - *Unsupported*. + + * - ``squashmigrations`` + - ✓ + - ✓ + + * - ``startapp`` + - ✓ + - ✓ + + * - ``startproject`` + - ✓ + - ✓ + + * - ``test`` + - ✓ + - ✓ + + * - ``testserver`` + - ✓ + - ✓ + +Migration Support +~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -401,16 +706,34 @@ Migration Limitations - Public Preview Support - General Availability Support + * - Creating, deleting, and updating indexes through migration + commands + - *Partially Supported*. You cannot update indexes on embedded model + or array fields. + - *Full Support Not Planned*. + * - `DDL Transactions <{+django-docs+}/topics/migrations/#transactions>`__ - *Unsupported*. - *Unsupported*. + * - Making migrations + - ✓ + - ✓ + * - ``migrate --fake-initial`` option - *Unsupported*. - *Unsupported*. -Third Party Library Limitations -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + * - Recording schema history + - ✓ + - ✓ + + * - Storing migration files + - ✓ + - ✓ + +Third Party Library Support +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 From 5d0c1d3eb67cd88d908d2d286d492a700876e926 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 19 Mar 2025 11:34:45 -0400 Subject: [PATCH 04/19] more info --- source/limitations-upcoming.txt | 105 +++++++++++++++++++++++--------- 1 file changed, 76 insertions(+), 29 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index e32795b..331d7aa 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -28,12 +28,6 @@ releases. We will prioritize these upcoming features based on user demand, and you can request support for a feature by :ref:`creating a JIRA issue `. -.. important:: - - Unsupported features that have a checkmark (``✓``) symbol in the - ``General Availability Support`` column are planned for the GA - release. However, support is not guaranteed. - MongoDB Features ---------------- @@ -41,6 +35,12 @@ This section indicates whether the {+django-odm+} supports various MongoDB features and which features we plan to support in the GA release. +.. important:: + + Unsupported MongoDB features that have a checkmark (``✓``) symbol in the + **General Availability Support** column are planned for the GA + release. However, support is not guaranteed. + Index Support ~~~~~~~~~~~~~ @@ -153,7 +153,7 @@ Query Support - ✓ * - Delete operations - - ✓ Use ``delete()``. + - ✓ - ✓ * - Geospatial queries @@ -163,15 +163,15 @@ Query Support - ✓ * - Insert operations - - ✓ Use ``create()`` or ``save()``. + - ✓ - ✓ * - Read operations - - ✓ Use ``filter()`` or ``get()``. + - ✓ - ✓ * - Update operations - - ✓ Use ``update()``. + - ✓ - ✓ * - Vector Search queries @@ -193,26 +193,32 @@ Database and Collection Support * - Asynchronous support - *Unsupported*. - - ✓ - - * - Collection interaction - - ✓ Use Django models to represent MongoDB collections. - - ✓ + - *Unsupported*. However, we plan to add support for this feature + in a post-GA release. - * - Database interaction + * - Authentication - ✓ - ✓ - * - Transactions + * - Cached data storage - *Unsupported*. - ✓ + * - Change Streams + - *Unsupported*. + - *Unsupported*. However, we plan to add support for this feature + in a post-GA release. + * - Client-side Field Level Encryption and Queryable Encryption - *Unsupported*. - ✓ - * - Multiple models for one collection - - *Unsupported*. + * - Collection interaction + - ✓ + - ✓ + + * - Database interaction + - ✓ - ✓ * - GridFS @@ -220,17 +226,24 @@ Database and Collection Support - *Unsupported*. However, we plan to add support for this feature in a post-GA release. - * - Change Streams + * - Multiple models for one collection - *Unsupported*. - - *Unsupported*. However, we plan to add support for this feature - in a post-GA release. + - ✓ + + * - Representing documents + - ✓ Use models to represent MongoDB documents. + - ✓ * - Schema validation - *Unsupported*. - *Unsupported*. However, we plan to add support for this feature in a post-GA release. - * - Cached data storage + * - Timeseries data + - ✓ + - ✓ + + * - Transactions - *Unsupported*. - ✓ @@ -241,6 +254,12 @@ This section indicates whether the {+django-odm+} supports various {+framework+} features and which features we plan to support in the GA release. +.. important:: + + Unsupported {+framework+} features that have a checkmark (``✓``) symbol in the + **General Availability Support** column are planned for the GA + release. However, support is not guaranteed. + Field Type Support ~~~~~~~~~~~~~~~~~~ @@ -442,6 +461,11 @@ Query Support - ✓ - ✓ + * - ``JOIN`` operations + - *Partially Supported*. You can use MongoDB's :manual:`$lookup ` + pipeline stage to perform joins. + - *Full Support Not Planned*. + * - ``last()`` - ✓ - ✓ @@ -579,18 +603,41 @@ Database Function Support Management Support ~~~~~~~~~~~~~~~~~~ -{+django-odm+} supports the {+framework+} Admin interface, which -you can use as a management tool. To learn more, see the :ref:`django-get-started-create-admin` -step in the Get Started guide. +.. list-table:: + :header-rows: 1 + :widths: 30 30 40 + + * - {+framework+} Feature + - Public Preview Support + - General Availability Support + + * - {+framework+} Admin + - ✓ + - ✓ + + * - {+framework+} Forms + - ✓ + - ✓ + + * - {+framework+} Authentication + - ✓ + - ✓ + + * - Management commands + - *Partially Supported*. For a full list of supported and unsupported + commands, see the :ref:`following section `. + - *Full Support Not Planned*. + +.. _django-management-commands: -The following table describes {+django-odm+}'s support for -{+framework+} management commands: +Management Command Support +`````````````````````````` .. list-table:: :header-rows: 1 :widths: 30 30 40 - * - {+framework+} Admin Command + * - {+framework+} Command - Public Preview Support - General Availability Support From 5ffba3bc7b63a6ec125b4889db5a0265fc47a4c7 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 19 Mar 2025 11:42:54 -0400 Subject: [PATCH 05/19] fix --- source/limitations-upcoming.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 331d7aa..6bc9e16 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -89,7 +89,7 @@ Index Support - ✓ * - Updating ``EmbeddedModelFields`` indexes after model creation - - *Unsupported* + - *Unsupported*. - ✓ Field Type Support From 32deab9e2650b08771d46a8a4060ba02c9106e3b Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 19 Mar 2025 11:46:39 -0400 Subject: [PATCH 06/19] toc --- source/index.txt | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/source/index.txt b/source/index.txt index df10007..301138d 100644 --- a/source/index.txt +++ b/source/index.txt @@ -15,7 +15,7 @@ Django MongoDB Backend Connection Configuration Model Your Data Interact with Data - Limitations & Upcoming Features + Feature Compatibility Issues & Help Compatibility API Documentation <{+api+}> @@ -56,12 +56,11 @@ Interact with Data Learn how to use {+django-odm+} to perform operations on MongoDB data in the :ref:`django-interact-data` section. -Limitations and Upcoming Features ---------------------------------- +Django and MongoDB Feature Compatibility +---------------------------------------- -Learn about the features that {+django-odm+} does not support -and features that we plan to support in upcoming releases -in the :ref:`django-limitations` section. +Learn about {+django-odm+}'s support for {+framework+} and +MongoDB features in the :ref:`django-limitations` section. Compatibility ------------- From 5c21a5cadb77bcca408ba2aae3322385f03261a9 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 19 Mar 2025 11:47:00 -0400 Subject: [PATCH 07/19] toc again --- source/index.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.txt b/source/index.txt index 301138d..1146dc4 100644 --- a/source/index.txt +++ b/source/index.txt @@ -17,7 +17,7 @@ Django MongoDB Backend Interact with Data Feature Compatibility Issues & Help - Compatibility + Version Compatibility API Documentation <{+api+}> .. warning:: Public Preview From 865cfe1939427bac1c15aef05ede2b5b50d7f476 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 19 Mar 2025 13:52:10 -0400 Subject: [PATCH 08/19] third party wording --- source/limitations-upcoming.txt | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 6bc9e16..1bbaa63 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -792,20 +792,25 @@ Third Party Library Support * - `Django-filter `__ - *Unsupported*. - - ✓ + - *Partially Supported*. This release will support most use cases and outline + limitations. * - `Django Rest Framework `__ - *Unsupported*. - - ✓ + - *Partially Supported*. This release will support most use cases and outline + limitations. * - `Django-allauth `__ - *Unsupported*. - - ✓ + - *Partially Supported*. This release will support most use cases and outline + limitations. * - `Wagtail `__ - *Unsupported*. - - ✓ + - *Partially Supported*. This release will support most use cases and outline + limitations. * - `Django Debug Toolbar `__ - *Unsupported*. - - ✓ + - *Partially Supported*. This release will support most use cases and outline + limitations. From 96ea2fd73abc8ee6540366a95c4cffcb11895b0c Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 20 Mar 2025 10:26:37 -0400 Subject: [PATCH 09/19] TG feedback --- source/limitations-upcoming.txt | 63 +++++++++++++-------------------- 1 file changed, 25 insertions(+), 38 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 1bbaa63..3d87aa7 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -49,11 +49,11 @@ Index Support :widths: 30 30 40 * - MongoDB Feature - - Public Preview Support + - Current Support - General Availability Support * - Atlas Search and Atlas Vector Search indexes - - *Partially Supported*. You cannot use the Django + - *Unsupported*. You cannot use the Django Indexes API to create these indexes, but you can use the PyMongo Driver by :ref:`exposing your MongoClient `. - ✓ @@ -67,7 +67,7 @@ Index Support - ✓ * - Geospatial indexes - - *Partially Supported*. You cannot use the Django + - *Unsupported*. You cannot use the Django Indexes API to create these indexes, but you can use the PyMongo Driver by :ref:`exposing your MongoClient `. - ✓ @@ -92,15 +92,15 @@ Index Support - *Unsupported*. - ✓ -Field Type Support -~~~~~~~~~~~~~~~~~~ +Data Type Support +~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 30 30 40 - * - MongoDB Field Type - - Public Preview Support + * - BSON Data Type + - Current Support - General Availability Support * - ``Array`` @@ -124,8 +124,13 @@ Field Type Support - *Partial Support Planned*. We plan to add support for registering ``EmbeddedModel`` schema changes after creation. -{+django-odm+} currently supports all other MongoDB field types not included -in the preceding table. To view a full list of supported fields, see the :ref:`django-models-mongodb-fields` + * - ``Regular Expression`` + - *Unsupported*. + - *Unsupported*. However, we plan to support this type + in a post-GA release. + +{+django-odm+} currently supports all other MongoDB data types not included +in the preceding table. To view a full list of supported types, see the :ref:`django-models-mongodb-fields` section of the Create Models guide. Query Support @@ -136,7 +141,7 @@ Query Support :widths: 30 30 40 * - MongoDB Feature - - Public Preview Support + - Current Support - General Availability Support * - Aggregation operations @@ -188,13 +193,12 @@ Database and Collection Support :widths: 30 30 40 * - MongoDB Feature - - Public Preview Support + - Current Support - General Availability Support * - Asynchronous support - - *Unsupported*. - - *Unsupported*. However, we plan to add support for this feature - in a post-GA release. + - ✓ + - ✓ * - Authentication - ✓ @@ -268,7 +272,7 @@ Field Type Support :widths: 30 30 40 * - {+framework+} Field Type - - Public Preview Support + - Current Support - General Availability Support * - ``AutoField`` @@ -276,11 +280,6 @@ Field Type Support not supported. Instead, use ``ObjectIdField``. - *Unsupported*. - * - ``BSONRegExp`` - - *Unsupported*. - - *Unsupported*. However, we plan to support this field - in a post-GA release. - * - ``DateTimeField`` - *Partially Supported*. You can use this field type with the following limitations: @@ -345,7 +344,7 @@ Query Support :widths: 30 30 40 * - {+framework+} ``QuerySet`` Feature - - Public Preview Support + - Current Support - General Availability Support * - ``aggregate()`` @@ -548,7 +547,7 @@ Database Function Support :widths: 30 30 40 * - {+framework+} Function - - Public Preview Support + - Current Support - General Availability Support * - ``Chr`` @@ -608,7 +607,7 @@ Management Support :widths: 30 30 40 * - {+framework+} Feature - - Public Preview Support + - Current Support - General Availability Support * - {+framework+} Admin @@ -638,7 +637,7 @@ Management Command Support :widths: 30 30 40 * - {+framework+} Command - - Public Preview Support + - Current Support - General Availability Support * - ``check`` @@ -750,7 +749,7 @@ Migration Support :widths: 30 30 40 * - {+framework+} Feature - - Public Preview Support + - Current Support - General Availability Support * - Creating, deleting, and updating indexes through migration @@ -763,22 +762,10 @@ Migration Support - *Unsupported*. - *Unsupported*. - * - Making migrations - - ✓ - - ✓ - * - ``migrate --fake-initial`` option - *Unsupported*. - *Unsupported*. - * - Recording schema history - - ✓ - - ✓ - - * - Storing migration files - - ✓ - - ✓ - Third Party Library Support ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -787,7 +774,7 @@ Third Party Library Support :widths: 30 30 40 * - Library - - Public Preview Support + - Current Support - General Availability Support * - `Django-filter `__ From a5419a604be6fae9829f7677af3accb6b2330a43 Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 20 Mar 2025 10:30:13 -0400 Subject: [PATCH 10/19] database func --- source/limitations-upcoming.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 3d87aa7..352f790 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -599,6 +599,11 @@ Database Function Support properly because MongoDB converts the result back to UTC. - *Full Support Not Planned*. +{+django-odm+} currently supports all other database functions not included in +the preceding table. To view a full list of functions, see `Database Functions +<{+django-docs+}/ref/models/database-functions/>`__ in the {+framework+} +documentation. + Management Support ~~~~~~~~~~~~~~~~~~ From ffe522c41f4e6ea9e6bc709bc3b5012111bd7bad Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 20 Mar 2025 11:22:07 -0400 Subject: [PATCH 11/19] spacing issue --- source/limitations-upcoming.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 352f790..b15c5b3 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -785,24 +785,24 @@ Third Party Library Support * - `Django-filter `__ - *Unsupported*. - *Partially Supported*. This release will support most use cases and outline - limitations. + limitations. * - `Django Rest Framework `__ - *Unsupported*. - *Partially Supported*. This release will support most use cases and outline - limitations. + limitations. * - `Django-allauth `__ - *Unsupported*. - *Partially Supported*. This release will support most use cases and outline - limitations. + limitations. * - `Wagtail `__ - *Unsupported*. - *Partially Supported*. This release will support most use cases and outline - limitations. + limitations. * - `Django Debug Toolbar `__ - *Unsupported*. - *Partially Supported*. This release will support most use cases and outline - limitations. + limitations. From a48bad12c488949f79f83bfac453661269e2609e Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 27 Mar 2025 11:41:28 -0400 Subject: [PATCH 12/19] TG feedback --- source/limitations-upcoming.txt | 232 ++------------------------------ 1 file changed, 9 insertions(+), 223 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index b15c5b3..dfecff2 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -347,50 +347,10 @@ Query Support - Current Support - General Availability Support - * - ``aggregate()`` - - ✓ - - ✓ - - * - ``all()`` - - ✓ - - ✓ - - * - ``alias()`` - - ✓ - - ✓ - - * - ``AND`` operator (``&``) - - ✓ - - ✓ - - * - ``annotate()`` - - ✓ - - ✓ - - * - ``as_manager()`` - - ✓ - - ✓ - - * - ``bulk_create()`` - - ✓ - - ✓ - * - ``bulk_update()`` - *Unsupported*. - *Unsupported*. - * - ``count()`` - - ✓ - - ✓ - - * - ``contains()`` - - ✓ - - ✓ - - * - ``create()`` - - ✓ - - ✓ - * - ``dates()`` - *Unsupported*. - *Unsupported*. @@ -399,96 +359,24 @@ Query Support - *Unsupported*. - *Unsupported*. - * - ``defer()`` - - ✓ - - ✓ - * - ``delete()`` - *Partially Supported*. You cannot use this method to perform queries that span multiple collections. - *Full Support Not Planned*. - * - ``difference()`` - - ✓ - - ✓ - * - ``distinct()`` - *Unsupported*. - *Unsupported*. - * - ``earliest()`` - - ✓ - - ✓ - - * - ``exclude()`` - - ✓ - - ✓ - - * - ``exists()`` - - ✓ - - ✓ - - * - ``explain()`` - - ✓ - - ✓ - * - ``extra()`` - *Unsupported*. - *Unsupported*. - * - ``filter()`` - - ✓ - - ✓ - - * - ``first()`` - - ✓ - - ✓ - - * - ``get()`` - - ✓ - - ✓ - - * - ``get_or_create()`` - - ✓ - - ✓ - - * - ``in_bulk()`` - - ✓ - - ✓ - - * - ``intersection()`` - - ✓ - - ✓ - * - ``JOIN`` operations - *Partially Supported*. You can use MongoDB's :manual:`$lookup ` pipeline stage to perform joins. - *Full Support Not Planned*. - * - ``last()`` - - ✓ - - ✓ - - * - ``latest()`` - - ✓ - - ✓ - - * - ``none()`` - - ✓ - - ✓ - - * - ``only()`` - - ✓ - - ✓ - - * - ``OR`` operator (``|``) - - ✓ - - ✓ - - * - ``order_by()`` - - ✓ - - ✓ - * - ``prefetch_related()`` - *Unsupported*. - *Unsupported*. @@ -498,46 +386,15 @@ Query Support to run queries that use MongoDB's aggregation pipeline syntax. - *Unsupported*. - * - ``reverse()`` - - ✓ - - ✓ - - * - ``union()`` - - ✓ - - ✓ - * - ``update()`` - *Partially Supported*. You cannot use this method to perform queries that span multiple collections. - *Full Support Not Planned*. - * - ``update_or_create()`` - - ✓ - - ✓ - - * - ``using()`` - - ✓ - - ✓ - - * - ``select_for_update()`` - - ✓ - - ✓ - - * - ``select_related()`` - - ✓ - - ✓ - - * - ``values()`` - - ✓ - - ✓ - - * - ``values_list()`` - - ✓ - - ✓ - - * - ``XOR`` operator (``^``) - - ✓ - - ✓ +{+django-odm+} currently supports all other {+framework+} ``QuerySet`` methods not +included in the preceding table. To view the supported methods, see `QuerySet API +<{+django-docs+}/ref/models/querysets/#queryset-api>`__ in the {+framework+} +documentation. Database Function Support ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -628,7 +485,7 @@ Management Support - ✓ * - Management commands - - *Partially Supported*. For a full list of supported and unsupported + - *Partially Supported*. To view the unsupported commands, see the :ref:`following section `. - *Full Support Not Planned*. @@ -645,34 +502,14 @@ Management Command Support - Current Support - General Availability Support - * - ``check`` - - ✓ - - ✓ - - * - ``compilemessages`` - - ✓ - - ✓ - * - ``createcachetable`` - *Unsupported*. - *Unsupported*. - * - ``dbshell`` - - ✓ - - ✓ - - * - ``diffsettings`` - - ✓ - - ✓ - * - ``dumpdata`` - *Unsupported*. - ✓ - * - ``flush`` - - ✓ - - ✓ - * - ``inspectdb`` - *Unsupported*. - *Unsupported*. However, we plan to support this command @@ -682,69 +519,18 @@ Management Command Support - *Unsupported*. - ✓ - * - ``makemessages`` - - ✓ - - ✓ - - * - ``makemigrations`` - - ✓ - - ✓ - - * - ``migrate`` - - ✓ - - ✓ - - * - ``optimizemigration`` - - ✓ - - ✓ - - * - ``runserver`` - - ✓ - - ✓ - - * - ``sendtestemail`` - - ✓ - - ✓ - - * - ``shell`` - - ✓ - - ✓ - - * - ``showmigrations`` - - ✓ - - ✓ - * - ``sqlflush`` - *Unsupported*. - *Unsupported*. - * - ``sqlmigrate`` - - ✓ - - ✓ - * - ``sqlsequencereset`` - *Unsupported*. - *Unsupported*. - * - ``squashmigrations`` - - ✓ - - ✓ - - * - ``startapp`` - - ✓ - - ✓ - - * - ``startproject`` - - ✓ - - ✓ - - * - ``test`` - - ✓ - - ✓ - - * - ``testserver`` - - ✓ - - ✓ +{+django-odm+} currently supports all other management commands not included in +the preceding table. To view a full list of commands, see `Available commands +<{+django-docs+}/ref/django-admin/#available-commands>`__ in the {+framework+} +documentation. Migration Support ~~~~~~~~~~~~~~~~~ From e8036c8ab268b1243692d3c6a529f1736c5e1642 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 9 Apr 2025 17:59:43 -0400 Subject: [PATCH 13/19] edits --- snooty.toml | 1 + source/limitations-upcoming.txt | 16 ++++++++-------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/snooty.toml b/snooty.toml index 4e9c2df..1f5ad6e 100644 --- a/snooty.toml +++ b/snooty.toml @@ -21,3 +21,4 @@ django-docs = "https://docs.djangoproject.com/en/{+django-version+}" framework = "Django" pymongo-version = "4.11" pymongo-docs = "https://www.mongodb.com/docs/languages/python/pymongo-driver/current" +odm-cli = "https://django-mongodb-cli.readthedocs.io/en/{+django-version+}" diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index dfecff2..7b844a2 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -365,8 +365,8 @@ Query Support - *Full Support Not Planned*. * - ``distinct()`` - - *Unsupported*. - - *Unsupported*. + - ✓ + - ✓ * - ``extra()`` - *Unsupported*. @@ -569,14 +569,14 @@ Third Party Library Support - General Availability Support * - `Django-filter `__ - - *Unsupported*. - - *Partially Supported*. This release will support most use cases and outline - limitations. + - ✓ Most use cases are supported. For more information about support + for this library, see `Django filter <{+odm-cli+}/supported-libraries/django-filter.html>`__ + in the {+django-odm+} CLI documentation. + - ✓ * - `Django Rest Framework `__ - - *Unsupported*. - - *Partially Supported*. This release will support most use cases and outline - limitations. + - *Partially Supported*. + - *Partially Supported*. * - `Django-allauth `__ - *Unsupported*. From 1d318c57851ca066ba94073f321cb6f5695e8a0d Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 10 Apr 2025 11:26:34 -0400 Subject: [PATCH 14/19] feedback --- snooty.toml | 1 - source/limitations-upcoming.txt | 27 +++++++++++---------------- 2 files changed, 11 insertions(+), 17 deletions(-) diff --git a/snooty.toml b/snooty.toml index 1f5ad6e..4e9c2df 100644 --- a/snooty.toml +++ b/snooty.toml @@ -21,4 +21,3 @@ django-docs = "https://docs.djangoproject.com/en/{+django-version+}" framework = "Django" pymongo-version = "4.11" pymongo-docs = "https://www.mongodb.com/docs/languages/python/pymongo-driver/current" -odm-cli = "https://django-mongodb-cli.readthedocs.io/en/{+django-version+}" diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 7b844a2..49283c3 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -384,7 +384,7 @@ Query Support * - ``raw()`` - *Unsupported*. However, you can use the ``raw_aggregate()`` method to run queries that use MongoDB's aggregation pipeline syntax. - - *Unsupported*. + - *Full Support Not Planned*. * - ``update()`` - *Partially Supported*. You cannot use this method to perform @@ -569,26 +569,21 @@ Third Party Library Support - General Availability Support * - `Django-filter `__ - - ✓ Most use cases are supported. For more information about support - for this library, see `Django filter <{+odm-cli+}/supported-libraries/django-filter.html>`__ - in the {+django-odm+} CLI documentation. - - ✓ + - *Partially Supported*. Most use cases are supported. + - *Partially Supported*. This release will outline use case limitations. * - `Django Rest Framework `__ - - *Partially Supported*. - - *Partially Supported*. + - *Partially Supported*. Most use cases are supported. + - *Partially Supported*. This release will outline use case limitations. * - `Django-allauth `__ - - *Unsupported*. - - *Partially Supported*. This release will support most use cases and outline - limitations. + - *Partially Supported*. Most use cases are supported. + - *Partially Supported*. This release will outline use case limitations. * - `Wagtail `__ - - *Unsupported*. - - *Partially Supported*. This release will support most use cases and outline - limitations. + - *Partially Supported*. Most use cases are supported. + - *Partially Supported*. This release will outline use case limitations. * - `Django Debug Toolbar `__ - - *Unsupported*. - - *Partially Supported*. This release will support most use cases and outline - limitations. + - *Partially Supported*. Most use cases are supported. + - *Partially Supported*. This release will outline use case limitations. From 288ab213b190efe42be6917f4cee4911ca14d375 Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 10 Apr 2025 13:29:54 -0400 Subject: [PATCH 15/19] more feedback --- source/limitations-upcoming.txt | 52 +++++++++++++++------------------ 1 file changed, 24 insertions(+), 28 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 49283c3..d162726 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -95,6 +95,10 @@ Index Support Data Type Support ~~~~~~~~~~~~~~~~~ +{+django-odm+} currently supports all MongoDB data types not included +in the following table. To view a full list of supported types, see the +:ref:`django-models-mongodb-fields` section of the Create Models guide. + .. list-table:: :header-rows: 1 :widths: 30 30 40 @@ -129,10 +133,6 @@ Data Type Support - *Unsupported*. However, we plan to support this type in a post-GA release. -{+django-odm+} currently supports all other MongoDB data types not included -in the preceding table. To view a full list of supported types, see the :ref:`django-models-mongodb-fields` -section of the Create Models guide. - Query Support ~~~~~~~~~~~~~ @@ -267,6 +267,10 @@ the GA release. Field Type Support ~~~~~~~~~~~~~~~~~~ +{+django-odm+} currently supports all {+framework+} field types not included in +the following table. To view a full list of supported fields, see the :ref:`django-models-django-fields` +section of the Create Models guide. + .. list-table:: :header-rows: 1 :widths: 30 30 40 @@ -332,13 +336,14 @@ Field Type Support - *Full Support Not Planned*. However, we plan to address the ``Q`` object and ``None`` key filtering limitations in a post-GA release. -{+django-odm+} currently supports all other {+framework+} field types not included in -the preceding table. To view a full list of supported fields, see the :ref:`django-models-django-fields` -section of the Create Models guide. - Query Support ~~~~~~~~~~~~~ +{+django-odm+} currently supports all {+framework+} ``QuerySet`` methods not +included in the following table. To view the supported methods, see `QuerySet API +<{+django-docs+}/ref/models/querysets/#queryset-api>`__ in the {+framework+} +documentation. + .. list-table:: :header-rows: 1 :widths: 30 30 40 @@ -364,10 +369,6 @@ Query Support queries that span multiple collections. - *Full Support Not Planned*. - * - ``distinct()`` - - ✓ - - ✓ - * - ``extra()`` - *Unsupported*. - *Unsupported*. @@ -391,14 +392,14 @@ Query Support queries that span multiple collections. - *Full Support Not Planned*. -{+django-odm+} currently supports all other {+framework+} ``QuerySet`` methods not -included in the preceding table. To view the supported methods, see `QuerySet API -<{+django-docs+}/ref/models/querysets/#queryset-api>`__ in the {+framework+} -documentation. - Database Function Support ~~~~~~~~~~~~~~~~~~~~~~~~~ +{+django-odm+} currently supports all database functions not included in +the following table. To view a full list of functions, see `Database Functions +<{+django-docs+}/ref/models/database-functions/>`__ in the {+framework+} +documentation. + .. list-table:: :header-rows: 1 :widths: 30 30 40 @@ -456,11 +457,6 @@ Database Function Support properly because MongoDB converts the result back to UTC. - *Full Support Not Planned*. -{+django-odm+} currently supports all other database functions not included in -the preceding table. To view a full list of functions, see `Database Functions -<{+django-docs+}/ref/models/database-functions/>`__ in the {+framework+} -documentation. - Management Support ~~~~~~~~~~~~~~~~~~ @@ -494,6 +490,11 @@ Management Support Management Command Support `````````````````````````` +{+django-odm+} currently supports all management commands not included in +the following table. To view a full list of commands, see `Available commands +<{+django-docs+}/ref/django-admin/#available-commands>`__ in the {+framework+} +documentation. + .. list-table:: :header-rows: 1 :widths: 30 30 40 @@ -527,11 +528,6 @@ Management Command Support - *Unsupported*. - *Unsupported*. -{+django-odm+} currently supports all other management commands not included in -the preceding table. To view a full list of commands, see `Available commands -<{+django-docs+}/ref/django-admin/#available-commands>`__ in the {+framework+} -documentation. - Migration Support ~~~~~~~~~~~~~~~~~ @@ -581,7 +577,7 @@ Third Party Library Support - *Partially Supported*. This release will outline use case limitations. * - `Wagtail `__ - - *Partially Supported*. Most use cases are supported. + - *Unsupported*. - *Partially Supported*. This release will outline use case limitations. * - `Django Debug Toolbar `__ From bb9ba2e9099fd46d579af283940478c97ce0f389 Mon Sep 17 00:00:00 2001 From: norareidy Date: Thu, 10 Apr 2025 16:36:07 -0400 Subject: [PATCH 16/19] RR feedback --- source/limitations-upcoming.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index d162726..0202084 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -46,6 +46,7 @@ Index Support .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - MongoDB Feature @@ -101,6 +102,7 @@ in the following table. To view a full list of supported types, see the .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - BSON Data Type @@ -138,6 +140,7 @@ Query Support .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - MongoDB Feature @@ -190,6 +193,7 @@ Database and Collection Support .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - MongoDB Feature @@ -273,6 +277,7 @@ section of the Create Models guide. .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - {+framework+} Field Type @@ -346,6 +351,7 @@ documentation. .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - {+framework+} ``QuerySet`` Feature @@ -402,6 +408,7 @@ documentation. .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - {+framework+} Function @@ -462,6 +469,7 @@ Management Support .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - {+framework+} Feature @@ -533,6 +541,7 @@ Migration Support .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - {+framework+} Feature @@ -558,6 +567,7 @@ Third Party Library Support .. list-table:: :header-rows: 1 + :stub-columns: 1 :widths: 30 30 40 * - Library From 04f91004ded1dcc883c148add2936453906f7245 Mon Sep 17 00:00:00 2001 From: norareidy Date: Wed, 14 May 2025 15:37:19 -0400 Subject: [PATCH 17/19] TG updates --- source/limitations-upcoming.txt | 28 +++++++--------------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 0202084..186947d 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -209,7 +209,8 @@ Database and Collection Support - ✓ * - Cached data storage - - *Unsupported*. + - ✓ Use the ``django_mongodb_backend.cache.MongoDBCache`` backend rather + than {+framework+}'s built-in database cache backend, ``django.core.cache.backends.db.DatabaseCache``. - ✓ * - Change Streams @@ -358,18 +359,6 @@ documentation. - Current Support - General Availability Support - * - ``bulk_update()`` - - *Unsupported*. - - *Unsupported*. - - * - ``dates()`` - - *Unsupported*. - - *Unsupported*. - - * - ``datetimes()`` - - *Unsupported*. - - *Unsupported*. - * - ``delete()`` - *Partially Supported*. You cannot use this method to perform queries that span multiple collections. @@ -379,11 +368,6 @@ documentation. - *Unsupported*. - *Unsupported*. - * - ``JOIN`` operations - - *Partially Supported*. You can use MongoDB's :manual:`$lookup ` - pipeline stage to perform joins. - - *Full Support Not Planned*. - * - ``prefetch_related()`` - *Unsupported*. - *Unsupported*. @@ -460,8 +444,10 @@ documentation. - *Unsupported*. * - ``Trunc`` - - *Partially Supported*. The ``tzinfo`` parameter doesn't work - properly because MongoDB converts the result back to UTC. + - *Partially Supported*. The ``tzinfo`` parameter of the + :py:class:`~django.db.models.functions.TruncDate` and + :py:class:`~django.db.models.functions.TruncTime` database + functions is not supported. - *Full Support Not Planned*. Management Support @@ -512,7 +498,7 @@ documentation. - General Availability Support * - ``createcachetable`` - - *Unsupported*. + - *Unsupported*. Instead, use {+django-odm+}'s ``createcachecollection`` command. - *Unsupported*. * - ``dumpdata`` From f6a3b8ea6356567767e05752527a84117adfd231 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 20 May 2025 16:38:41 -0400 Subject: [PATCH 18/19] add year --- source/limitations-upcoming.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index 186947d..bd8fee4 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -39,7 +39,7 @@ the GA release. Unsupported MongoDB features that have a checkmark (``✓``) symbol in the **General Availability Support** column are planned for the GA - release. However, support is not guaranteed. + release later in 2025. However, support is not guaranteed. Index Support ~~~~~~~~~~~~~ @@ -267,7 +267,7 @@ the GA release. Unsupported {+framework+} features that have a checkmark (``✓``) symbol in the **General Availability Support** column are planned for the GA - release. However, support is not guaranteed. + release later in 2025. However, support is not guaranteed. Field Type Support ~~~~~~~~~~~~~~~~~~ From 943aea8e7675a8d32d3512682b73c7ea90965068 Mon Sep 17 00:00:00 2001 From: norareidy Date: Tue, 20 May 2025 16:41:35 -0400 Subject: [PATCH 19/19] planned ga support --- source/limitations-upcoming.txt | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/source/limitations-upcoming.txt b/source/limitations-upcoming.txt index bd8fee4..953edf9 100644 --- a/source/limitations-upcoming.txt +++ b/source/limitations-upcoming.txt @@ -38,7 +38,7 @@ the GA release. .. important:: Unsupported MongoDB features that have a checkmark (``✓``) symbol in the - **General Availability Support** column are planned for the GA + **Planned GA Support** column are planned for the General Availability release later in 2025. However, support is not guaranteed. Index Support @@ -51,7 +51,7 @@ Index Support * - MongoDB Feature - Current Support - - General Availability Support + - Planned GA Support * - Atlas Search and Atlas Vector Search indexes - *Unsupported*. You cannot use the Django @@ -107,7 +107,7 @@ in the following table. To view a full list of supported types, see the * - BSON Data Type - Current Support - - General Availability Support + - Planned GA Support * - ``Array`` - *Partially Supported*. You can use the ``ArrayField`` field type with the @@ -145,7 +145,7 @@ Query Support * - MongoDB Feature - Current Support - - General Availability Support + - Planned GA Support * - Aggregation operations - *Partially Supported*. The {+django-odm+} does not include custom @@ -198,7 +198,7 @@ Database and Collection Support * - MongoDB Feature - Current Support - - General Availability Support + - Planned GA Support * - Asynchronous support - ✓ @@ -283,7 +283,7 @@ section of the Create Models guide. * - {+framework+} Field Type - Current Support - - General Availability Support + - Planned GA Support * - ``AutoField`` - *Unsupported*. The ``BigAutoField`` and ``SmallAutoField`` types are also @@ -357,7 +357,7 @@ documentation. * - {+framework+} ``QuerySet`` Feature - Current Support - - General Availability Support + - Planned GA Support * - ``delete()`` - *Partially Supported*. You cannot use this method to perform @@ -397,7 +397,7 @@ documentation. * - {+framework+} Function - Current Support - - General Availability Support + - Planned GA Support * - ``Chr`` - *Unsupported*. @@ -460,7 +460,7 @@ Management Support * - {+framework+} Feature - Current Support - - General Availability Support + - Planned GA Support * - {+framework+} Admin - ✓ @@ -495,7 +495,7 @@ documentation. * - {+framework+} Command - Current Support - - General Availability Support + - Planned GA Support * - ``createcachetable`` - *Unsupported*. Instead, use {+django-odm+}'s ``createcachecollection`` command. @@ -532,7 +532,7 @@ Migration Support * - {+framework+} Feature - Current Support - - General Availability Support + - Planned GA Support * - Creating, deleting, and updating indexes through migration commands @@ -558,7 +558,7 @@ Third Party Library Support * - Library - Current Support - - General Availability Support + - Planned GA Support * - `Django-filter `__ - *Partially Supported*. Most use cases are supported.