Method list_indexes

pymongo/synchronous/collection.py:2508–2544

Get a cursor over the index documents for this collection. >>> for index in db.test.list_indexes(): ... print(index) ... SON([('v', 2), ('key', SON([('_id', 1)])), ('name', '_id_')]) Cursors are closed automatically when they are exhausted (the l

(
        self,
        session: Optional[ClientSession] = None,
        comment: Optional[Any] = None,
    )

        self.database.client._retryable_write(False, inner, session, _Op.DROP_INDEXES)

    def list_indexes(
        self,
        session: Optional[ClientSession] = None,
        comment: Optional[Any] = None,
    ) -> CommandCursor[MutableMapping[str, Any]]:
        """Get a cursor over the index documents for this collection.

          >>> for index in db.test.list_indexes():
          ...     print(index)
          ...
          SON([('v', 2), ('key', SON([('_id', 1)])), ('name', '_id_')])

        Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
        If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
        To avoid this, best practice is to call :meth:`Cursor.close` when the cursor is no longer needed,
        or use the cursor in a with statement::

            with collection.list_indexes() as cursor:
                for index in cursor:
                    print(index)

        :param session: a
            :class:`~pymongo.client_session.ClientSession`.
        :param comment: A user-provided comment to attach to this
            command.

        :return: An instance of :class:`~pymongo.command_cursor.CommandCursor`.

        .. versionchanged:: 4.1
           Added ``comment`` parameter.

        .. versionchanged:: 3.6
           Added ``session`` parameter.

        .. versionadded:: 3.0
        """
        return self._list_indexes(session, comment)

    def _list_indexes(
        self,