Skip to content

Commit d73b2a1

Browse files
committed
DOCSP-13944 clarify _id resumeToken definition for change streams
1 parent 20c2a3d commit d73b2a1

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

source/reference/change-events.txt

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,21 +60,27 @@ following table describes each field in the change stream response document:
6060

6161
* - ``_id``
6262
- document
63-
- Metadata related to the operation.
63+
- .. _change-stream-event-id:
64+
65+
A :term:`BSON` object which serves as an identifier for the
66+
change stream event. This value is used as the ``resumeToken``
67+
for the ``resumeAfter`` parameter when resuming a change stream.
68+
The ``_id`` object has the following form:
6469

6570
.. code-block:: none
6671

6772
{
6873
"_data" : <BinData|hex string>
6974
}
7075

71-
Use this document as a ``resumeToken`` for the ``resumeAfter``
72-
parameter when resuming a change stream.
76+
The ``_data`` type depends on the MongoDB versions
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.
7381

74-
The resume token ``_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`.
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)