DOCSP-18486 decode a resume token

Author: mungitoperrito

source/changeStreams.txt

@@ -17,8 +17,6 @@ Change Streams
    :description: MongoDB triggers, change streams, database triggers, real time
    :keywords: MongoDB triggers, change streams, database triggers, real time
 
-.. versionadded:: 3.6
-
 Change streams allow applications to access real-time data changes
 without the complexity and risk of tailing the :term:`oplog`.
 Applications can use change streams to subscribe to all data changes on
@@ -953,13 +951,17 @@ The ``_id`` value of a :ref:`change stream event document
       "_data" : <BinData|hex string>
    }
 
+.. tip::
+
+   .. include:: /includes/extracts/4.2-changes-change-stream-modification-error.rst
+
 .. include:: /includes/extracts/changestream-resume-token-versions-4.2-greater.rst
 
 .. include:: /includes/extracts/changestream-resume-token-hex-change.rst
 
 .. tip::
 
-   .. include:: /includes/extracts/4.2-changes-change-stream-modification-error.rst
+   .. include:: /includes/note-decode-resume-tokens.rst
 
 Use Cases
 ---------

source/includes/note-decode-resume-tokens.rst

@@ -0,0 +1,28 @@
+MongoDB provides a :ref:`"snippet" <snip-overview>`, an 
+extension to :binary:`~bin.mongosh`, that decodes hex-encoded
+resume tokens.
+
+You can install and run the `resumetoken
+<https://github.com/mongodb-labs/mongosh-snippets/tree/main/snippets/resumetoken>`__
+snippet from :binary:`~bin.mongosh`:
+
+.. code-block:: javascript
+
+   snippet install resumetoken
+   decodeResumeToken('<RESUME TOKEN>')
+
+You can also run `resumetoken
+<https://github.com/mongodb-labs/mongosh-snippets/tree/main/snippets/resumetoken>`__
+from the command line (without using :binary:`~bin.mongosh`) if ``npm``
+is installed on your system:
+
+.. code-block:: javascript
+
+   npx mongodb-resumetoken-decoder <RESUME TOKEN>
+
+See the following for more details on:
+
+- `resumetoken
+  <https://github.com/mongodb-labs/mongosh-snippets/tree/main/snippets/resumetoken>`__
+- :ref:`using snippets <snip-using-snippets>` in :binary:`~bin.mongosh`.
+

source/reference/method/Mongo.watch.txt

@@ -239,8 +239,16 @@ Resumability
 
    .. include:: /includes/extracts/changestream-resume-token-versions-4.2-greater.rst
 
+   Hex Encoded Tokens
+   ``````````````````
+
    .. include:: /includes/extracts/changestream-resume-token-hex-change.rst
 
+   Decode Resume Tokens
+   ````````````````````
+
+   .. include:: /includes/note-decode-resume-tokens.rst
+
 Full Document Lookup of Update Operations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

source/reference/method/db.collection.watch.txt

@@ -60,14 +60,9 @@ Definition
           You must pass an empty array ``[]`` to the ``pipeline`` parameter if
           you are not specifying a pipeline but are passing the ``options``
           document.
-          
-          
-   
-
 
    The ``options`` document can contain the following fields and values:
 
-
    .. list-table::
       :header-rows: 1
       :widths: 20 20 80
@@ -178,15 +173,8 @@ Definition
 
           ``startAtOperationTime`` is mutually exclusive with ``resumeAfter``
           and ``startAfter``.
-          
-          
-          
-          .. versionadded:: 4.0
-          
-          
-          
-   
 
+          .. versionadded:: 4.0
 
    :returns:
       A :term:`cursor` that remains open as long as a connection to the
@@ -242,8 +230,16 @@ Resumability
 
    .. include:: /includes/extracts/changestream-resume-token-versions-4.2-greater.rst
 
+   Hex Encoded Tokens
+   ``````````````````
+
    .. include:: /includes/extracts/changestream-resume-token-hex-change.rst
 
+   Decode Resume Tokens
+   ````````````````````
+
+   .. include:: /includes/note-decode-resume-tokens.rst
+
 .. |watchmethod| replace:: :method:`db.collection.watch()`
 
 

source/reference/method/db.watch.txt

@@ -178,10 +178,6 @@ Definition
 
           ``startAtOperationTime`` is mutually exclusive with ``resumeAfter``
           and ``startAfter``.
-          
-          
-   
-
 
    :returns:
       A :term:`cursor` over the change event documents.
@@ -243,8 +239,16 @@ Resumability
 
    .. include:: /includes/extracts/changestream-resume-token-versions-4.2-greater.rst
 
+   Hex Encoded Tokens
+   ``````````````````
+
    .. include:: /includes/extracts/changestream-resume-token-hex-change.rst
 
+   Decode Resume Tokens
+   ````````````````````
+
+   .. include:: /includes/note-decode-resume-tokens.rst
+
 .. |watchmethod| replace:: :method:`db.watch()`
 
 Full Document Lookup of Update Operations