Skip to content

Commit 1e70951

Browse files
committed
DOCSP-13944 clarify _id resumeToken definition for change streams
1 parent b335602 commit 1e70951

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

source/reference/change-events.txt

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,10 @@ following table describes each field in the change stream response document:
6262
- document
6363
- .. _change-stream-event-id:
6464

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

6870
.. code-block:: none
6971

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

7476
The ``_data`` type depends on the MongoDB versions
75-
and, in some cases, the feature compatibility version (fcv) at
76-
the time of the change stream's opening/resumption. For details,
77-
see :ref:`change-stream-resume-token`.
77+
and, in some cases, the :ref:`feature compatibility version (fCV)
78+
<view-fcv>` at the time of the change stream's
79+
opening/resumption. See :ref:`change-stream-resume-token` for the
80+
full list of ``_data`` types.
81+
82+
See :ref:`change-stream-resume` for an example of resuming a
83+
change stream by ``resumeToken``.
7884

7985
* - ``operationType``
8086
- string

0 commit comments

Comments
 (0)