DOCSP-11180: UpdateOneBusinessKeyTimestampStrategy documentation (#35)

Author: Chris Cho

source/kafka-sink-postprocessors.txt

@@ -427,7 +427,7 @@ The record contains the following data after applying the projection:
 
    {
      "forecast": [
-       { 
+       {
          "day": "Monday",
          "uv": 5
        }
@@ -663,6 +663,10 @@ strategies are provided with the connector:
 
        .. seealso:: Example of usage in :ref:`writemodel-strategy-timestamps`.
 
+   * - UpdateOneBusinessKeyTimestampStrategy
+     - | Add ``_insertedTS`` (inserted timestamp) and ``_modifiedTS`` (modified timestamp) fields into documents that match the filters provided by the ``document.id.strategy`` setting.
+       | Set the following configuration: ``writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.UpdateOneBusinessKeyTimestampStrategy``
+
 .. note::
 
    Future versions of the MongoDB Kafka Connector will allow developers to
@@ -676,12 +680,12 @@ WriteModel Strategy: Business Keys
 A business key is a value comprised of data within the sink record that
 identifies it as a unique document. This example defines a business key
 using data contained within multiple fields in the record as well as
-instructs the post processor to generate *BSON ObjectIds* for inserts, 
+instructs the post processor to generate *BSON ObjectIds* for inserts,
 but not for updates.
 
 The following steps are required to configure this strategy:
 
-#. Create a :manual:`unique index </core/index-unique>` that corresponds to 
+#. Create a :manual:`unique index </core/index-unique>` that corresponds to
    your business key in your target MongoDB collection.
 #. In the connector configuration, specify the ``PartialValueStrategy``
    as the id strategy to identify the fields that belong to the business
@@ -690,7 +694,7 @@ The following steps are required to configure this strategy:
    ``ReplaceOneBusinessKeyStrategy`` writemodel strategy.
 
 For this example, we track airplane capacity by the flight number and
-airport it is currently located represented by ``flight_no`` and 
+airport it is currently located represented by ``flight_no`` and
 ``airport_code``, respectively. An example message contains the following:
 
 .. code-block:: json
@@ -755,18 +759,18 @@ values without changing the ``_id`` field.
      }
    }
 
-.. admonition:: Projection post processors are not compatible with PartialValueStrategy 
+.. admonition:: Projection post processors are not compatible with PartialValueStrategy
    :class: warning
 
-   The ``PartialValueStrategy`` id strategy uses the 
+   The ``PartialValueStrategy`` id strategy uses the
    ``[key|value].projection.type`` and ``[key|value].projection.list``
-   settings to define which fields are used to form the ``_id`` field. 
+   settings to define which fields are used to form the ``_id`` field.
    Since the Blocklist and Allowlist post processors use the same
    projection settings, they cannot be specified separately. Use a `Single
    Message Transform (SMT)
    <https://docs.confluent.io/current/connect/transforms/index.html>`_
-   outside the connector to format your source data as necessary. 
-   
+   outside the connector to format your source data as necessary.
+
 .. _writemodel-strategy-timestamps:
 
 WriteModel Strategy: Inserted and Modified Timestamps