cursor.showRecordId.txt

=====================
cursor.showRecordId()
=====================

.. default-domain:: mongodb

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

Definition
----------

.. method:: cursor.showRecordId()

   .. include:: /includes/fact-mongosh-shell-method.rst

   Appends the ``$recordId`` field to documents returned by a query.
   ``$recordId`` is the internal key that uniquely identifies a document
   in a collection. ``$recordId`` format:

   .. code-block:: javascript
      :copyable: false

      '$recordId': Long(<int>)

   :returns: A modified cursor object that contains the document fields
             and the appended ``$recordId`` field.

Compatibility
-------------

This method is available in deployments hosted in the following environments: 

.. include:: /includes/fact-environments-atlas-only.rst

.. include:: /includes/fact-environments-atlas-support-all.rst

.. include:: /includes/fact-environments-onprem-only.rst

Example
-------

.. include:: /includes/example-showRecordId.rst