DOCSP-32096: use id in tombstone events (#143)

* DOCSP-32096: use id in tombstone events

* CC suggestions

* CC discussion

* formatting

Author: rustagir

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

@@ -23,6 +23,8 @@ with the {+source-connector+}.
 
 .. include:: /includes/source-config-link.rst
 
+.. _source-configuration-change-stream-list:
+
 Settings
 --------
 
@@ -113,10 +115,11 @@ Settings
        |
        | **Description:**
        | Whether to return only the ``fullDocument`` field from the
-         change stream event document produced by any update event. The ``fullDocument`` field
-         contains the most current version of the updated document. To
-         learn more about the ``fullDocument`` field, see the :rapid:`Server
-         manual page on update events </reference/change-events/update/>`.
+         change stream event document produced by any update event. The
+         ``fullDocument`` field contains the most current version of the
+         updated document. To learn more about the ``fullDocument``
+         field, see the :manual:`update Event
+         </reference/change-events/update/>` in the Server manual.
 
        | When set to ``true``, the connector overrides the
          ``change.stream.full.document`` setting and sets it to
@@ -138,6 +141,21 @@ Settings
        | **Default**: ``false``
        | **Accepted Values**: ``true`` or ``false``
 
+   * - | **change.stream.document.key.as.key**
+     - | **Type:** boolean
+       |
+       | **Description:**
+       | Whether to use the document key for the source record key if
+         the document key is present.
+
+       | When set to ``true``, the connector adds keys of the deleted
+         documents to the tombstone events. When set to ``false``,
+         the connector uses the resume token as the source key for
+         the tombstone events.
+
+       | **Default**: ``true``
+       | **Accepted Values**: ``true`` or ``false``
+
    * - | **collation**
      - | **Type:** string
        |

source/whats-new.txt

@@ -34,6 +34,17 @@ Learn what's new by version:
 What's New in 1.11
 --------------------
 
+.. important:: Breaking Changes in Tombstone Event Creation
+   
+   This release adds the ``change.stream.document.key.as.key`` source
+   connector configuration property and sets it to ``true`` by default.
+
+   Now, tombstone events use the keys of deleted documents as source record
+   keys. To revert the tombstone event behavior, set
+   ``change.stream.document.key.as.key`` to ``false``. To learn more
+   about this property, see the list of :ref:`Change Stream Properties
+   <source-configuration-change-stream-list>`.
+
 - Added support for regular expressions in the ``topic.namespace.map`` property.
 
 - Added support for setting a custom delete write model strategy by using the
@@ -42,6 +53,16 @@ What's New in 1.11
 - Added the ``UpdateOneDefaultStrategy`` write model strategy. To learn
   more, see the list of :ref:`Write Model Strategies <sink-connector-write-model-strategies>`.
 
+- Added the ``change.stream.document.key.as.key`` source
+  connector configuration property. When set to ``true``, the
+  connector adds keys of the deleted documents to the tombstone events.
+  When set to ``false``, the connector uses the resume token as the source key
+  for the tombstone events.
+  
+  Because this property is set to ``true`` by
+  default, this might be a breaking change for some users. To learn more,
+  see the list of :ref:`Change Stream Properties <source-configuration-change-stream-list>`.
+
 - DDL events from Debezium are recorded as no-ops and no longer cause an error.
 
 .. _kafka-connector-whats-new-1.10.1: