PYTHON-2201 Deprecate the Collection.reindex method

Author: prashantmital

doc/changelog.rst

@@ -38,6 +38,9 @@ Version 3.11 adds support for MongoDB 4.4. Highlights include:
   :meth:`pymongo.collection.Collection.find`. Starting in MongoDB 4.4, the
   server optimizes queries against the oplog collection without requiring
   the user to set this flag.
+- Deprecated :meth:`pymongo.collection.Collection.reindex`. Use
+  :meth:`~pymongo.database.Database.command` to run the ``reIndex`` command
+  instead.
 
 .. _validate command: https://docs.mongodb.com/manual/reference/command/validate/
 

pymongo/collection.py

@@ -2178,6 +2178,15 @@ def drop_index(self, index_or_name, session=None, **kwargs):
     def reindex(self, session=None, **kwargs):
         """Rebuilds all indexes on this collection.
 
+        **DEPRECATED** - The :meth:`~reindex` method is deprecated and will be
+        removed in PyMongo 4.0. Use :meth:`~pymongo.database.Database.command`
+        to run the ``reIndex`` command directly instead::
+
+          db.command({"reIndex": "<collection_name>"})
+
+        .. note:: Starting in MongoDB 4.6, the `reIndex` command can only be
+          run when connected to a standalone mongod.
+
         :Parameters:
           - `session` (optional): a
             :class:`~pymongo.client_session.ClientSession`.
@@ -2188,19 +2197,26 @@ def reindex(self, session=None, **kwargs):
            are built in the foreground) and will be slow for large
            collections.
 
+        .. versionchanged:: 3.11
+           Deprecated.
+
         .. versionchanged:: 3.6
            Added ``session`` parameter. Added support for arbitrary keyword
            arguments.
 
-        .. versionchanged:: 3.4
-           Apply this collection's write concern automatically to this operation
-           when connected to MongoDB >= 3.4.
-
         .. versionchanged:: 3.5
            We no longer apply this collection's write concern to this operation.
            MongoDB 3.4 silently ignored the write concern. MongoDB 3.6+ returns
            an error if we include the write concern.
+
+        .. versionchanged:: 3.4
+           Apply this collection's write concern automatically to this operation
+           when connected to MongoDB >= 3.4.
         """
+        warnings.warn("The reindex method is deprecated and will be removed in "
+                      "PyMongo 4.0. Use the Database.command method to run the "
+                      "reIndex command instead.",
+                      DeprecationWarning, stacklevel=2)
         cmd = SON([("reIndex", self.__name)])
         cmd.update(kwargs)
         with self._socket_for_writes(session) as sock_info:

test/__init__.py

@@ -671,7 +671,9 @@ def mongos_seeds(self):
     @property
     def supports_reindex(self):
         """Does the connected server support reindex?"""
-        return not (self.version.at_least(4, 1, 0) and self.is_mongos)
+        return not ((self.version.at_least(4, 1, 0) and self.is_mongos) or
+                    (self.version.at_least(4, 5, 0) and (
+                            self.is_mongos or self.is_rs)))
 
     @property
     def supports_getpreverror(self):

test/test_legacy_api.py

@@ -105,6 +105,9 @@ def test_ensure_index_deprecation(self):
         finally:
             self.db.test.drop()
 
+    def test_reindex_deprecation(self):
+        self.assertRaises(DeprecationWarning, lambda: self.db.test.reindex())
+
 
 class TestLegacy(IntegrationTest):