Session.txt

=======
Session
=======

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. method:: Session

   .. versionadded:: 3.6

   The Session object for the connection in the :binary:`~bin.mongo` shell.
   To instantiate a session for the connection in the :binary:`~bin.mongo`
   shell, see :method:`Mongo.startSession()`. For more information on
   sessions, see :ref:`sessions`.

   .. list-table::

      * - Method
        - Description

      * - .. method:: Session.getDatabase(<database>)

        - Access the specified database from the session in the :binary:`~bin.mongo` shell.

      * - .. method:: Session.advanceClusterTime({ clusterTime: <timestamp>, signature: { hash: <BinData>, keyId: <NumberLong> } })

        - Updates the cluster time tracked by the session.

      * - .. method:: Session.advanceOperationTime(<timestamp>)

        - Updates the operation time.

      * - .. method:: Session.endSession()

        - Ends the session.

      * - .. method:: Session.hasEnded()

        - Returns a boolean that specifies whether the session has
          ended.

      * - .. method:: Session.getClusterTime()

        - Returns the most recent cluster time as seen by the session.
          Applicable for replica sets and sharded clusters only.

      * - .. method:: Session.getOperationTime()

        - Returns the timestamp of the last acknowledged operation for
          the session.

      * - .. method:: Session.getOptions()

        - Access the options for the session. For the available
          options, see :method:`SessionOptions`.

      * - :method:`Session.startTransaction()`

        - Starts a multi-document transaction for the session. For
          details, see :method:`Session.startTransaction()`.

      * - :method:`Session.commitTransaction()`

        - Commits the session's transaction. For details, see
          :method:`Session.commitTransaction()`.

      * - :method:`Session.abortTransaction()`

        - Aborts the session's transaction. For details, see
          :method:`Session.abortTransaction()`.

Example
-------

The following example starts a session on the :method:`Mongo`
connection object associated with the :binary:`~bin.mongo` shell's global
``db`` variable, and then uses the :method:`Session.getDatabase()`
method to retrieve the database object associated with the session.

.. code-block:: javascript

   var session = db.getMongo().startSession();
   db = session.getDatabase(db.getName());


.. toctree::
   :titlesonly:
   :hidden:

   /reference/method/Session.abortTransaction
   /reference/method/Session.commitTransaction
   /reference/method/Session.startTransaction