DOCSP-48184: Rework limitations and upcoming #27

norareidy · 2025-03-14T15:20:03Z

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-48184

Staging Links

index

limitations-upcoming

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

netlify · 2025-03-14T15:29:03Z

✅ Deploy Preview for docs-django ready!

Name	Link
🔨 Latest commit	`bb9ba2e`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-django/deploys/67f82bbc55091100082b0d44
😎 Deploy Preview	https://deploy-preview-27--docs-django.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

source/limitations-upcoming.txt

timgraham · 2025-03-19T17:01:34Z

source/limitations-upcoming.txt

+       not supported. Instead, use ``ObjectIdField``.
+     - *Unsupported*.
+
+   * - ``BSONRegExp``


This is not a field but a BSON data type.

Moved to the Mongodb "Data Type Support" section

timgraham · 2025-03-19T17:08:46Z

source/limitations-upcoming.txt


-Performance
-~~~~~~~~~~~
+   * - ``compilemessages``


It's strange to list all the management commands as many of them do not interact with the database.

Which commands do you think are relevant to include?

As in other sections, including only the unsupported commands is sufficient.

timgraham · 2025-03-19T17:10:23Z

source/limitations-upcoming.txt

+   * - `Django-filter <https://django-filter.readthedocs.io/en/stable/>`__
+     - *Unsupported*.
+     - ✓


As far as I know, it is supported because @aclark4life didn't identify any needed changes.

Following up with him!

timgraham · 2025-03-19T17:11:54Z

source/limitations-upcoming.txt

+   * - Making migrations
+     - ✓
+     - ✓


It is strange to list "Making migrations, Recording schema history, Storing migration files". These are the basics of the migrations system, and we wouldn't have any support without them.

I'll remove

timgraham · 2025-03-19T17:12:37Z

source/limitations-upcoming.txt

+     - *Full Support Not Planned*. However, we plan to address the
+       ``Q`` object and ``None`` key filtering limitations in a post-GA release.


I'm not sure they can be. \cc @WaVEV

It is hard to implement; all operators must consider the null factor and handle it separately, given the nature of null in SQL. Null values behave as either false or true in filtering. Sometimes a filter filters for when a condition is met, and other times for when it is not. As a result, having a condition C and its negation ~C can yield overlapping results between both queries. This behavior occurs in SQL but not in MongoDB.

timgraham · 2025-03-19T17:14:58Z

source/limitations-upcoming.txt

+   * - ``as_manager()``
+     - ✓
+     - ✓


This isn't a method that interacts with the database. Do we need to list every supported method? You didn't list every supported model field, so there seems to be a slight inconsistency.

Since there's already a list of all supported model fields in the Models guide, I linked out to it instead of repeating them. But I agree that this table is pretty long; I can just list the unsupported/partially supported, then link to the Django QuerySet docs and say that we support all other methods not mentioned?

Sounds good to me.

timgraham · 2025-03-19T17:19:24Z

source/limitations-upcoming.txt

+   * - 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 <django-client-operations>`.


By this definition (partial support = can do it in pymongo), I'd think nearly everything that's unsupported would be considered partially supported.

I changed to "Unsupported" but kept the information about exposing the MongoClient

timgraham · 2025-04-09T01:29:02Z

source/limitations-upcoming.txt

+   * - ``distinct()``
+     - *Unsupported*.
+     - *Unsupported*.


Correction: distinct() is supported.

rustagir

overall looks great, just left a comment to format differently for readability.

rustagir · 2025-04-10T19:42:32Z

source/limitations-upcoming.txt


- ``DurationField``
+.. list-table::


S: suggest adding a stub column to all tables to separate the feature name from the support columns

R-shubham

Can we follow the same template on the limitation page as Laravel?

One of the things I noticed from users who read this page was - the way we had a big list of not supported feature..some user walked away with the impression that there is a lot that need to be done vs..a great deal of feature is supported & here is things that is in works, or has limitations.

For example, I’m reading indexes section - may be we can say all index type is supported except these “3”. Kind of baking in a full picture. We may not need to go in details of every supported features and can use blanket statement like, all of Django's queryset function is known to be supported except a,b,c.

norareidy · 2025-05-06T14:51:38Z

Can we follow the same template on the limitation page as Laravel?

One of the things I noticed from users who read this page was - the way we had a big list of not supported feature..some user walked away with the impression that there is a lot that need to be done vs..a great deal of feature is supported & here is things that is in works, or has limitations.

For example, I’m reading indexes section - may be we can say all index type is supported except these “3”. Kind of baking in a full picture. We may not need to go in details of every supported features and can use blanket statement like, all of Django's queryset function is known to be supported except a,b,c.

Hi Shubham! Can you clarify what you mean by same template - the same two-column table format? After the GA release the tables will have two columns (feature and availability), but for now I think it makes more sense to separate Public Preview and GA availability. See this thread for a discussion about that. Or do you mean the same subheaders? I reused the subheaders that applied (Query, Database, Migration support) but most of the Laravel sections are Laravel-specific (Eloquent Relationships, Mutator, Model Factory, etc). But let me know if there's something I'm missing from the Laravel page.

And yes, I can rework each section to just include what we don’t support with a statement like “everything is supported except the following”, similar to what I have in Data Type, Field Type, etc.

rachel-mack

Adding this to close #31

rachel-mack · 2025-05-12T13:04:11Z

source/limitations-upcoming.txt

+     - *Unsupported*. The ``BigAutoField`` and ``SmallAutoField`` types are also
+       not supported. Instead, use ``ObjectIdField``.
+     - *Unsupported*.
+


Add this here in favour of #31

Suggested change

* - ``CompositePrimaryKey``

- *Unsupported*.

- *Unsupported*.

Updates for Django 5.2 could be deferred until after this PR, but changes for Django 5.2 shouldn't be mixed in with this refactor. For one, mixing concerns like that will make backporting more difficult.

timgraham · 2025-05-13T14:16:44Z

source/limitations-upcoming.txt

+   * - ``bulk_update()``
+     - *Unsupported*.
+     - *Unsupported*.
+
+   * - ``dates()``
+     - *Unsupported*.
+     - *Unsupported*.
+
+   * - ``datetimes()``
+     - *Unsupported*.
+     - *Unsupported*.


bulk_update/dates/datetimes are all supported.

timgraham · 2025-05-13T14:17:19Z

source/limitations-upcoming.txt

+   * - ``JOIN`` operations
+     - *Partially Supported*. You can use MongoDB's :manual:`$lookup </reference/operator/aggregation/lookup/>`
+       pipeline stage to perform joins.
+     - *Full Support Not Planned*.


The backend automatically uses $lookup. There is nothing for the user to do. I'm not sure why this is considered "partial support".

timgraham · 2025-05-13T14:18:34Z

source/limitations-upcoming.txt

+   * - Cached data storage
+     - *Unsupported*.
+     - ✓


Supported as per 39d9ffe.

timgraham · 2025-05-13T14:18:51Z

source/limitations-upcoming.txt

+   * - ``createcachetable``
+     - *Unsupported*.
+     - *Unsupported*.


Add note per 39d9ffe.

timgraham · 2025-05-13T14:19:08Z

source/limitations-upcoming.txt

+     - *Partially Supported*. The ``tzinfo`` parameter doesn't work
+       properly because MongoDB converts the result back to UTC.
+     - *Full Support Not Planned*.


Update per 39d9ffe.

DOCSP-48184: Rework limitations and upcoming

0d16938

edits

33d7ca6

norareidy marked this pull request as ready for review March 17, 2025 14:44

norareidy added 5 commits March 19, 2025 11:11

edits to include support

ba1beb8

more info

5d0c1d3

fix

5ffba3b

toc

32deab9

toc again

5c21a5c

timgraham reviewed Mar 19, 2025

View reviewed changes

norareidy added 5 commits March 19, 2025 13:52

third party wording

865cfe1

TG feedback

96ea2fd

database func

a5419a6

spacing issue

ffe522c

TG feedback

a48bad1

timgraham reviewed Apr 9, 2025

View reviewed changes

norareidy added 3 commits April 9, 2025 17:59

edits

e8036c8

feedback

1d318c5

more feedback

288ab21

rustagir approved these changes Apr 10, 2025

View reviewed changes

RR feedback

bb9ba2e

norareidy requested a review from R-shubham April 10, 2025 20:39

R-shubham requested changes Apr 29, 2025

View reviewed changes

norareidy mentioned this pull request May 7, 2025

[Django] CompositePrimaryKey isn't supported #31

Closed

5 tasks

rachel-mack requested changes May 12, 2025

View reviewed changes

timgraham reviewed May 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-48184: Rework limitations and upcoming #27

DOCSP-48184: Rework limitations and upcoming #27

norareidy commented Mar 14, 2025 •

edited by github-actions bot

Loading

netlify bot commented Mar 14, 2025 •

edited

Loading

timgraham Mar 19, 2025

norareidy Mar 20, 2025

timgraham Mar 19, 2025

norareidy Mar 20, 2025

timgraham Mar 21, 2025

timgraham Mar 19, 2025

norareidy Mar 27, 2025

timgraham Mar 19, 2025

norareidy Mar 20, 2025

timgraham Mar 19, 2025

WaVEV May 13, 2025

timgraham Mar 19, 2025

norareidy Mar 20, 2025

timgraham Mar 25, 2025

timgraham Mar 19, 2025

norareidy Mar 20, 2025

timgraham Apr 9, 2025

rustagir left a comment

rustagir Apr 10, 2025

R-shubham left a comment

norareidy commented May 6, 2025

rachel-mack left a comment

rachel-mack May 12, 2025

timgraham May 12, 2025

timgraham May 13, 2025

timgraham May 13, 2025

timgraham May 13, 2025

timgraham May 13, 2025

timgraham May 13, 2025

		- Full Support Not Planned. However, we plan to address the
		``Q`` object and ``None`` key filtering limitations in a post-GA release.

DOCSP-48184: Rework limitations and upcoming #27

Are you sure you want to change the base?

DOCSP-48184: Rework limitations and upcoming #27

Conversation

norareidy commented Mar 14, 2025 • edited by github-actions bot Loading

Pull Request Info

Staging Links

Self-Review Checklist

netlify bot commented Mar 14, 2025 • edited Loading

✅ Deploy Preview for docs-django ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustagir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

R-shubham left a comment

Choose a reason for hiding this comment

norareidy commented May 6, 2025

rachel-mack left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

norareidy commented Mar 14, 2025 •

edited by github-actions bot

Loading

netlify bot commented Mar 14, 2025 •

edited

Loading