Method bind

pymongo/synchronous/client_session.py:598–614

Bind this session so it is implicitly passed to all database operations within the returned context. .. code-block:: python with client.start_session() as s: with s.bind(): # session=s is passed implicitly client.db.collection

(self, end_session: bool = True)

            raise InvalidOperation("Cannot use ended session")

    def bind(self, end_session: bool = True) -> _BoundSessionContext:
        """Bind this session so it is implicitly passed to all database operations within the returned context.

        .. code-block:: python

           with client.start_session() as s:
               with s.bind():
                   # session=s is passed implicitly
                   client.db.collection.insert_one({"x": 1})

        :param end_session: Whether to end the session on exiting the returned context. Defaults to True.
            If set to False, :meth:`~pymongo.client_session.ClientSession.end_session()` must be called
            once the session is no longer used.

        .. versionadded:: 4.17
        """
        return _BoundSessionContext(self, end_session)

    def __enter__(self) -> ClientSession:
        return self