DOCSP-49758: Atlas search indexes #29
Conversation
✅ Deploy Preview for docs-django ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| class Meta: | ||
| db_table = "recipes" | ||
| indexes = [ | ||
| SearchIndex(fields=["title"], |
There was a problem hiding this comment.
This is the indent style that Django uses:
SearchIndex(
fields=["title"],
name="title_search_idx",
)
source/model-data/indexes.txt
Outdated
|
|
||
| - ``fields``: The fields you want to index. | ||
| - ``name``: *(Optional)* The name of your Atlas Search index. If you do not | ||
| specify this argument, {+django-odm+} automatically generates an index name. |
There was a problem hiding this comment.
It's actually the behavior of Django to automatically generate an index name rather than Django Mongo Backend.
|
|
||
| To create an Atlas Search index, assign the ``indexes`` option in your model's | ||
| ``Meta`` class to a ``SearchIndex`` object. Pass the following arguments to the | ||
| ``SearchIndex()`` constructor: |
There was a problem hiding this comment.
It would be great to add interphinx support for django_mongodb_backend, e.g.
:class:`~django_mongodb_backend.indexes.SearchIndex`
(could be done separately)
There was a problem hiding this comment.
I added a link to the SearchIndex class to the tip at the end of this section
source/model-data/indexes.txt
Outdated
| Atlas Search Indexes | ||
| ~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Atlas Search indexes specify the behavior of an Atlas Search, or a full-text |
There was a problem hiding this comment.
I'm a bit naive on this functionaltiy, but I'm not sure what "or" means here. Does it mean "in other words"?
https://www.mongodb.com/docs/atlas/atlas-search/ says "Atlas Search is an embedded full-text search"
There was a problem hiding this comment.
Yes, "in other words." I changed to "which is" for clarity
|
Also, this feature will only be in Django MongoDB Backend 5.2.x for Django 5.2.x, so a prerequisite to this documentation is to create the branch for 5.1.x and update the master branch to 5.2.x. |
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-49758
Staging Links
Self-Review Checklist