Skip to content

Document that $ and . aren't supported in Field.db_column #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 20, 2025
Merged

Document that $ and . aren't supported in Field.db_column #421

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/ref/models/fields.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,18 @@ A few notes about some of the other fields:
- Similarly, all :class:`~django.db.models.DurationField` values are stored as
:class:`bson.int64.Int64`.

Model field options
===================

Some notes about model field options:

- Dollar signs and periods (``$`` and ``.``) are not supported in
:attr:`Field.db_column <django.db.models.Field.db_column>` because these field
names are :doc:`discouraged by MongoDB
<manual:core/dot-dollar-considerations>`. Querying fields with these
characters requires the ``$getField`` operator, which prevents queries from
using indexes.

MongoDB-specific model fields
=============================

Expand Down
Loading