DOCSP-32089: add update write model strategy (#142)

* DOCSP-32089: add write model strategy

* fix anchor to get rid of error

* fix anchor again

Author: rustagir

source/sink-connector/configuration-properties/write-strategies.txt

@@ -44,7 +44,9 @@ Strategies
    * - | **DefaultWriteModelStrategy**
        | 
      - | **Description:**
-       | This strategy uses the ``ReplaceOneDefaultStrategy`` by default, and the ``InsertOneDefaultStrategy`` if you set the ``timeseries.timefield`` option.
+       | This strategy uses the ``ReplaceOneDefaultStrategy`` by
+         default, and the ``InsertOneDefaultStrategy`` if you set the
+         ``timeseries.timefield`` option.
        | 
        | This is the default value for the ``writemodel.strategy`` configuration setting.
 
@@ -61,7 +63,9 @@ Strategies
    * - | **ReplaceOneDefaultStrategy**
        |
      - | **Description:**
-       | Replaces at most one document in MongoDB that matches a sink record by the ``_id`` field. If no documents match, insert the sink record as a new document.
+       | Replaces at most one document in MongoDB that matches a sink
+         record by the ``_id`` field. If no documents match, the
+         connector inserts the sink record as a new document.
        | Apply the following configuration to your sink connector to specify this setting: 
 
        .. code-block:: properties
@@ -71,19 +75,24 @@ Strategies
    * - | **ReplaceOneBusinessKeyStrategy**
        | 
      - | **Description:**
-       | Replaces at most one document that matches a sink record by a specified business key. If no documents match, insert the sink record as a new document.
+       | Replaces at most one document that matches a sink record by a
+         specified business key. If no documents match, the
+         connector inserts the sink record as a new document.
        | Apply the following configuration to your sink connector to specify this setting: 
 
        .. code-block:: properties
 
           writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.ReplaceOneBusinessKeyStrategy
 
-       | To see an example showing how to use this strategy, see our :ref:`guide on write model strategies <kafka-sink-write-model-replace-example>`.
+       | To see an example showing how to use this strategy, see our
+         :ref:`guide on write model strategies <kafka-sink-write-model-replace-example>`.
 
    * - | **DeleteOneDefaultStrategy**
        | 
      - | **Description:**
-       | Deletes at most one document that matches your sink connector's key structure by the ``_id`` field only when the document contains a null value structure.
+       | Deletes at most one document that matches your sink connector's
+         key structure by the ``_id`` field only when the document
+         contains a null value structure.
        | This is implicitly specified when you set ``mongodb.delete.on.null.values=true``.
        | You can set this explicitly with the following configuration: 
 
@@ -101,7 +110,20 @@ Strategies
 
           writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.DeleteOneBusinessKeyStrategy
 
-       | To see an example showing how to use this strategy, see our :ref:`guide on write model strategies <kafka-sink-write-model-delete-example>`.
+       | To see an example showing how to use this strategy, see our
+         :ref:`guide on write model strategies <kafka-sink-write-model-delete-example>`.
+
+   * - | **UpdateOneDefaultStrategy**
+       |
+     - | **Description:**
+       | Updates at most one document in MongoDB that matches a sink
+         record by the ``_id`` field. If no documents match, the
+         connector inserts the sink record as a new document.
+       | Apply the following configuration to your sink connector to specify this setting: 
+       
+       .. code-block:: properties
+           
+          writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.UpdateOneDefaultStrategy
 
    * - | **UpdateOneTimestampsStrategy**
        | 
@@ -113,12 +135,15 @@ Strategies
 
           writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.UpdateOneTimestampsStrategy
 
-       | To see an example showing how to use this strategy, see our :ref:`guide on write model strategies <kafka-sink-write-model-time-example>`.
+       | To see an example showing how to use this strategy, see our
+         :ref:`guide on write model strategies <kafka-sink-write-model-time-example>`. 
 
    * - | **UpdateOneBusinessKeyTimestampStrategy**
        | 
      - | **Description:**
-       | Add ``_insertedTS`` (inserted timestamp) and ``_modifiedTS`` (modified timestamp) fields into documents that match a business key.
+       | Add ``_insertedTS`` (inserted timestamp) and ``_modifiedTS``
+         (modified timestamp) fields into documents that match a business
+         key.
        | Apply the following configuration to your sink connector to specify this setting: 
 
        .. code-block:: properties

source/sink-connector/fundamentals/write-strategies.txt

@@ -1,4 +1,4 @@
-.. _sink-connector-write-model-strategies:
+.. _sink-connector-write-model-strategies-guide:
 
 ======================
 Write Model Strategies
@@ -20,7 +20,8 @@ You can change how your connector writes data to MongoDB for use cases
 including the following:
 
 - Insert documents instead of upserting them
-- Replace documents that match a filter other than the ``_id`` field
+- Replace or update documents that match a filter other than the ``_id``
+  field
 - Delete documents that match a filter
 
 You can configure how your connector writes data to MongoDB by specifying a

source/whats-new.txt

@@ -36,10 +36,11 @@ What's New in 1.11
 
 - Added support for regular expressions in the ``topic.namespace.map`` property.
 
-- Added support for setting a custom delete write model strategy using the
-  ``delete.writemodel.strategy`` propery.
+- Added support for setting a custom delete write model strategy by using the
+  ``delete.writemodel.strategy`` configuration property.
 
-- Added the ``UpdateOneDefaultStrategy`` write model strategy.
+- Added the ``UpdateOneDefaultStrategy`` write model strategy. To learn
+  more, see the list of :ref:`Write Model Strategies <sink-connector-write-model-strategies>`.
 
 - DDL events from Debezium are recorded as no-ops and no longer cause an error.