@@ -64,11 +64,15 @@ Settings
64
64
| **Description:**
65
65
| Determines what values your change stream returns on update
66
66
operations.
67
- | The `` default`` setting returns the differences between the original
67
+ | The default setting returns the differences between the original
68
68
document and the updated document.
69
69
| The ``updateLookup`` setting returns the differences between the
70
70
original document and updated document as well as a copy of the
71
71
entire updated document at a *point in time* after the update.
72
+ | The ``whenAvailable`` setting returns the updated document,
73
+ if available.
74
+ | The ``required`` setting returns the updated document and
75
+ raises an error if it is not available.
72
76
73
77
.. tip::
74
78
@@ -78,7 +82,32 @@ Settings
78
82
79
83
|
80
84
| **Default**: ``""``
81
- | **Accepted Values**: ``""`` or ``"default"`` or ``"updateLookup"``
85
+ | **Accepted Values**: ``""``, ``"updateLookup"``, ``"whenAvailable"``, or ``"required"``
86
+
87
+ * - | **change.stream.full.document.before.change**
88
+ - | **Type:** string
89
+ |
90
+ | **Description:**
91
+ | Configures the document pre-image your change stream returns on update
92
+ operations. The pre-image is not available for source records
93
+ published while copying existing data, and the pre-image configuration
94
+ has no effect on copying.
95
+
96
+ .. tip::
97
+
98
+ To learn how to configure a collection to enable
99
+ pre-images, see the :manual:`Server manual entry on pre- and
100
+ post-images </changeStreams/#change-streams-with-document-pre--and-post-images>`.
101
+
102
+ | The default setting suppresses the document pre-image.
103
+ | The ``whenAvailable`` setting returns the document pre-image if
104
+ it's available, before it was replaced, updated, or
105
+ deleted.
106
+ | The ``required`` setting returns the document pre-image and
107
+ raises an error if it is not available.
108
+ |
109
+ | **Default**: ``""``
110
+ | **Accepted Values**: ``""`` or ``"whenAvailable"`` or ``"required"``
82
111
83
112
* - | **publish.full.document.only**
84
113
- | **Type:** boolean
0 commit comments