Skip to content

Commit 3c9c0d8

Browse files
authored
DOCSP-26559: clarify what full document property does (#63)
* DOCSP-26559: clarify what full document property does * CC PR fixes 1 * CC PR fixes 2 * CC suggestions
1 parent 6c7e009 commit 3c9c0d8

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

source/source-connector/configuration-properties/change-stream.txt

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,14 @@ Settings
4141
|
4242
| **Description:**
4343
| An array of aggregation pipelines to run in your change stream.
44+
You must configure this setting for the change stream
45+
event document, not the ``fullDocument`` field.
4446

4547
.. example::
4648

4749
.. code-block:: none
4850

49-
[{"$match": {"operationType": "insert"}}, {"$addFields": {"Kafka": "Rules!"}}]
51+
[{"$match": { "$and": [{"operationType": "insert"}, {"fullDocument.eventId": 1404 }] } }]
5052

5153
.. tip:: Additional Examples
5254

@@ -82,11 +84,16 @@ Settings
8284
- | **Type:** boolean
8385
|
8486
| **Description:**
85-
| Whether to publish the changed document instead of the full change
86-
stream document. When set to ``true``, the connector
87-
automatically sets the ``change.stream.full.document`` property to
88-
``updateLookup`` to receive the updated documents.
89-
|
87+
| Whether to return only the ``fullDocument`` field from the
88+
change stream event document produced by any update event. The ``fullDocument`` field
89+
contains the most current version of the updated document. To
90+
learn more about the ``fullDocument`` field, see the :rapid:`Server
91+
manual page on update events </reference/change-events/update/>`.
92+
| When set to ``true``, the connector overrides the
93+
``change.stream.full.document`` setting and sets it to
94+
``updateLookup`` so that the ``fullDocument`` field contains
95+
updated documents.
96+
9097
| **Default**: ``false``
9198
| **Accepted Values**: ``true`` or ``false``
9299

0 commit comments

Comments
 (0)