DOCSP-29571: delete writemodel (#145)

* DOCSP-29571: delete writemodel strategy

* fixes

* wording fix

* tip

* note

* CC PR fixes 1

* change examples

* CC PR fixes 2

* RL nit change

Author: rustagir

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

@@ -15,13 +15,44 @@ Overview
 
 .. _sink-configuration-write-model-strategy-description-start:
 
-Use the strategies in the following table to specify how the {+sink-connector+}
-writes data into MongoDB. You can specify a write strategy with the following
+You can set configuration properties to specify how the
+{+sink-connector+} writes data into MongoDB. The following sections
+describe the configuration properties that you can set to customize this
+behavior.
+
+Write Model
+~~~~~~~~~~~
+
+Set the ``writemodel.strategy`` configuration property to specify how
+the sink connector writes data when it receives a sink record.
+
+You can set the value of ``writemodel.strategy`` to any of the
+fully qualified class names of the write model strategies described in
+the :ref:`Strategies <sink-connector-write-model-strategies>` section of
+this page. You can specify a strategy by setting the following
+configuration:
+
+.. code-block:: properties
+
+   writemodel.strategy=<a write model strategy>
+
+Delete Write Model
+~~~~~~~~~~~~~~~~~~
+
+Set the ``delete.writemodel.strategy`` configuration property to specify
+how the sink connector writes data when it receives a tombstone
+event. A tombstone event is a record that contains a key but no
+value, which signifies a deleted record.
+
+You can set the value of ``delete.writemodel.strategy`` to any of the
+fully qualified class names of the write model strategies described in
+the :ref:`Strategies <sink-connector-write-model-strategies>` section of
+this page. You can specify a strategy by setting the following
 configuration:
 
 .. code-block:: properties
 
-   writemodel.strategy=<a writemodel strategy>
+   delete.writemodel.strategy=<a write model strategy>
 
 .. _sink-configuration-write-model-strategy-description-end:
 
@@ -48,41 +79,45 @@ Strategies
          default, and the ``InsertOneDefaultStrategy`` if you set the
          ``timeseries.timefield`` option.
        | 
-       | This is the default value for the ``writemodel.strategy`` configuration setting.
+       | This is the default value value for the ``writemodel.strategy``
+         configuration property.
 
    * - | **InsertOneDefaultStrategy**
        | 
      - | **Description:**
        | Insert each sink record into MongoDB as a document. 
-       | Apply the following configuration to your sink connector to specify this setting: 
+       | To specify this strategy, set the configuration property to the
+         following class name:
 
-       .. code-block:: properties
+       .. code-block:: none
 
-          writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.InsertOneDefaultStrategy
+          com.mongodb.kafka.connect.sink.writemodel.strategy.InsertOneDefaultStrategy
 
    * - | **ReplaceOneDefaultStrategy**
        |
      - | **Description:**
        | 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: 
+       | To specify this strategy, set the configuration property to the
+         following class name:
 
-       .. code-block:: properties
+       .. code-block:: none
 
-          writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.ReplaceOneDefaultStrategy
+          com.mongodb.kafka.connect.sink.writemodel.strategy.ReplaceOneDefaultStrategy
 
    * - | **ReplaceOneBusinessKeyStrategy**
        | 
      - | **Description:**
        | 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: 
+       | To specify this strategy, set the configuration property to the
+         following class name: 
 
-       .. code-block:: properties
+       .. code-block:: none
 
-          writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.ReplaceOneBusinessKeyStrategy
+          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>`.
@@ -93,22 +128,30 @@ Strategies
        | 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: 
+       |
+       | This is the default value for the
+         ``delete.writemodel.strategy`` configuration property.
+       |
+       | This strategy is set as the default value of the
+         ``writemodel.strategy`` property when you set
+         ``mongodb.delete.on.null.values=true``.
+       | To specify this strategy, set the configuration property to the
+         following class name:
 
-       .. code-block:: properties
+       .. code-block:: none
 
-          writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.DeleteOneDefaultStrategy
+          com.mongodb.kafka.connect.sink.writemodel.strategy.DeleteOneDefaultStrategy
 
    * - | **DeleteOneBusinessKeyStrategy**
        | 
      - | **Description:**
        | Deletes at most one MongoDB document that matches a sink record by a business key.
-       | Apply the following configuration to your sink connector to specify this setting: 
+       | To specify this strategy, set the configuration property to the
+         following class name:
 
-       .. code-block:: properties
+       .. code-block:: none
 
-          writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.DeleteOneBusinessKeyStrategy
+          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>`.
@@ -119,21 +162,23 @@ Strategies
        | 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
+       | To specify this strategy, set the configuration property to the
+         following class name:
+
+       .. code-block:: none
 
-          writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.UpdateOneDefaultStrategy
+          com.mongodb.kafka.connect.sink.writemodel.strategy.UpdateOneDefaultStrategy
 
    * - | **UpdateOneTimestampsStrategy**
        | 
      - | **Description:**
        | Add ``_insertedTS`` (inserted timestamp) and ``_modifiedTS`` (modified timestamp) fields into documents.
-       | Apply the following configuration to your sink connector to specify this setting: 
-       
-       .. code-block:: properties
-           
-          writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.UpdateOneTimestampsStrategy
+       | To specify this strategy, set the configuration property to the
+         following class name:
+
+       .. code-block:: none
+          
+          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>`. 
@@ -144,10 +189,11 @@ Strategies
        | 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
+       | To specify this strategy, set the configuration property to the
+         following class name:
+
+       .. code-block:: none
 
-          writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.UpdateOneBusinessKeyTimestampStrategy
+          com.mongodb.kafka.connect.sink.writemodel.strategy.UpdateOneBusinessKeyTimestampStrategy
 
-.. _sink-configuration-write-model-strategy-table-end:
+.. _sink-configuration-write-model-strategy-table-end:

source/whats-new.txt

@@ -41,7 +41,8 @@ What's New in 1.11
   Naming page.
 
 - Added support for setting a custom delete write model strategy by using the
-  ``delete.writemodel.strategy`` configuration property.
+  ``delete.writemodel.strategy`` configuration property. To learn more,
+  see :ref:`sink-configuration-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>`.