Skip to content

DOCSP-13944 clarify _id resumeToken definition for change streams #4788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions source/reference/change-events.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,10 @@ following table describes each field in the change stream response document:
- document
- .. _change-stream-event-id:

Metadata related to the operation. Acts as the ``resumeToken``
A :term:`BSON` object which serves as an identifier for the
change stream event. This value is used as the ``resumeToken``
for the ``resumeAfter`` parameter when resuming a change stream.
The ``_id`` object has the following form:

.. code-block:: none

Expand All @@ -72,9 +74,13 @@ following table describes each field in the change stream response document:
}

The ``_data`` type depends on the MongoDB versions
and, in some cases, the feature compatibility version (fcv) at
the time of the change stream's opening/resumption. For details,
see :ref:`change-stream-resume-token`.
and, in some cases, the :ref:`feature compatibility version (fCV)
<view-fcv>` at the time of the change stream's
opening/resumption. See :ref:`change-stream-resume-token` for the
full list of ``_data`` types.

See :ref:`change-stream-resume` for an example of resuming a
change stream by ``resumeToken``.

* - ``operationType``
- string
Expand Down