edits

Author: timgraham

django_mongodb_backend/features.py

@@ -558,9 +558,10 @@ def supports_atlas_search(self):
             # the operation will not error when unsupported.
             self.connection.get_collection("django_migrations").list_search_indexes()
         except OperationFailure:
-            # It would be best to check the error message or error code to, but
-            # they vary across MongoDB versions. Example: "$listSearchIndexes
-            # stage is only allowed on MongoDB Atlas".
+            # It would be best to check the error message or error code to
+            # avoid hiding some other exception, but the message/code varies
+            # across MongoDB versions. Example error message:
+            # "$listSearchIndexes  stage is only allowed on MongoDB Atlas".
             return False
         else:
             return True

docs/source/ref/models/indexes.rst

@@ -5,8 +5,9 @@ Model index reference
 .. module:: django_mongodb_backend.indexes
    :synopsis: Database indexes for MongoDB.
 
-Some MongoDB-specific indexes are available in
-``django_mongodb_backend.indexes``.
+Some MongoDB-specific :doc:`indexes <django:ref/models/indexes>`, for use on a
+model's :attr:`Meta.indexes <django.db.models.Options.indexes>` option, are
+available in ``django_mongodb_backend.indexes``.
 
 ``SearchIndex``
 ===============

docs/source/releases/5.2.x.rst

@@ -18,8 +18,8 @@ New features
 
 *These features won't appear in Django MongoDB Backend 5.1.x.*
 
-- Added :class:`.SearchIndex` and :class:`.VectorSearchIndex` for using on
-  a model's ``Meta.indexes``.
+- Added :class:`.SearchIndex` and :class:`.VectorSearchIndex` for use on
+  a model's :attr:`Meta.indexes <django.db.models.Options.indexes>`.
 
 Backwards incompatible changes
 ------------------------------

tests/indexes_/test_search_indexes.py

@@ -48,7 +48,7 @@ def test_no_init_args(self):
             SearchIndex("foo")
 
     def test_no_extra_kargs(self):
-        """Unused wargs that appear on Index aren't accepted."""
+        """Unused kwargs that appear on Index aren't accepted."""
         msg = "SearchIndex.__init__() got an unexpected keyword argument 'condition'"
         with self.assertRaisesMessage(TypeError, msg):
             SearchIndex(condition="")
@@ -62,12 +62,12 @@ def test_no_init_args(self):
             VectorSearchIndex("foo")
 
     def test_no_extra_kargs(self):
-        """Unused wargs that appear on Index aren't accepted."""
+        """Unused kwargs that appear on Index aren't accepted."""
         msg = "VectorSearchIndex.__init__() got an unexpected keyword argument 'condition'"
         with self.assertRaisesMessage(TypeError, msg):
             VectorSearchIndex(condition="")
 
-    def test_no_similarities(self):
+    def test_similarities_required(self):
         msg = (
             "VectorSearchIndex.__init__() missing 1 required keyword-only argument: 'similarities'"
         )
@@ -248,49 +248,6 @@ def test_multiple_fields(self):
             with connection.schema_editor() as editor:
                 editor.remove_index(index=index, model=SearchIndexTestModel)
 
-    def test_similarities_value(self):
-        index = VectorSearchIndex(
-            name="recent_test_idx",
-            fields=["vector_float", "vector_integer"],
-            similarities="euclidean",
-        )
-        with connection.schema_editor() as editor:
-            editor.add_index(index=index, model=SearchIndexTestModel)
-        try:
-            index_info = connection.introspection.get_constraints(
-                cursor=None,
-                table_name=SearchIndexTestModel._meta.db_table,
-            )
-            expected_options = {
-                "latestDefinition": {
-                    "fields": [
-                        {
-                            "numDimensions": 10,
-                            "path": "vector_float",
-                            "similarity": "euclidean",
-                            "type": "vector",
-                        },
-                        {
-                            "numDimensions": 10,
-                            "path": "vector_integer",
-                            "similarity": "euclidean",
-                            "type": "vector",
-                        },
-                    ]
-                },
-                "latestVersion": 0,
-                "name": "recent_test_idx",
-                "queryable": False,
-                "type": "vectorSearch",
-            }
-            self.assertCountEqual(index_info[index.name]["columns"], index.fields)
-            index_info[index.name]["options"].pop("id")
-            index_info[index.name]["options"].pop("status")
-            self.assertEqual(index_info[index.name]["options"], expected_options)
-        finally:
-            with connection.schema_editor() as editor:
-                editor.remove_index(index=index, model=SearchIndexTestModel)
-
     def test_similarities_list(self):
         index = VectorSearchIndex(
             name="recent_test_idx",