DBZ-3416 Consistent docs for all connectors

This commit is contained in:
Gunnar Morling 2021-04-13 10:26:46 +02:00
parent 2b0d74f2ac
commit 6eae0daeaa
8 changed files with 38 additions and 25 deletions

View File

@ -223,6 +223,7 @@ Raghava Ponnam
Ram Satish
Ramesh Reddy
Randall Hauch
Raphael Auv
Raúl Tovar
Renato Mefi
René Kerner

View File

@ -1869,13 +1869,13 @@ Depending on the `_hashAlgorithm_` used, the `_salt_` selected, and the actual d
|[[db2-property-tombstones-on-delete]]<<db2-property-tombstones-on-delete, `+tombstones.on.delete+`>>
|`true`
| Controls whether a tombstone event should be generated after a _delete_ event. +
|Controls whether a _delete_ event is followed by a tombstone event. +
+
`true` - delete operations are represented by a _delete_ event and a subsequent tombstone event. +
`true` - a delete operation is represented by a _delete_ event and a subsequent tombstone event. +
+
`false` - only a _delete_ event is sent. +
`false` - only a _delete_ event is emitted. +
+
After a _delete_ operation, emitting a tombstone event enables Kafka to delete all change event records that have the same key as the deleted row.
After a source record is deleted, emitting a tombstone event (the default behavior) allows Kafka to completely delete all events that pertain to the key of the deleted row in case {link-kafka-docs}/#compaction[log compaction] is enabled for the topic.
|[[db2-property-include-schema-changes]]<<db2-property-include-schema-changes, `+include.schema.changes+`>>
|`true`

View File

@ -1155,9 +1155,13 @@ Must not be used with `collection.include.list`.
|[[mongodb-property-tombstones-on-delete]]<<mongodb-property-tombstones-on-delete, `+tombstones.on.delete+`>>
|`true`
| Controls whether a tombstone event should be generated after a delete event. +
When `true` the delete operations are represented by a delete event and a subsequent tombstone event. When `false` only a delete event is sent. +
Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted.
|Controls whether a _delete_ event is followed by a tombstone event. +
+
`true` - a delete operation is represented by a _delete_ event and a subsequent tombstone event. +
+
`false` - only a _delete_ event is emitted. +
+
After a source record is deleted, emitting a tombstone event (the default behavior) allows Kafka to completely delete all events that pertain to the key of the deleted row in case {link-kafka-docs}/#compaction[log compaction] is enabled for the topic.
|[[mongodb-property-snapshot-delay-ms]]<<mongodb-property-snapshot-delay-ms, `+snapshot.delay.ms+`>>
|

View File

@ -2287,13 +2287,13 @@ endif::community[]
|[[mysql-property-tombstones-on-delete]]<<mysql-property-tombstones-on-delete, `+tombstones.on.delete+`>>
|`true`
|Controls whether a delete event is followed by a tombstone event. +
|Controls whether a _delete_ event is followed by a tombstone event. +
+
`true` - a delete operation is represented by a delete event and a subsequent tombstone event. +
`true` - a delete operation is represented by a _delete_ event and a subsequent tombstone event. +
+
`false` - only a delete event is emitted. +
`false` - only a _delete_ event is emitted. +
+
After a source record is deleted, emitting a tombstone event (the default behavior) allows Kafka to completely delete all events that pertain to the key of the deleted row (in case your topic is configured with compaction).
After a source record is deleted, emitting a tombstone event (the default behavior) allows Kafka to completely delete all events that pertain to the key of the deleted row in case {link-kafka-docs}/#compaction[log compaction] is enabled for the topic.
|[[mysql-property-message-key-columns]]<<mysql-property-message-key-columns, `+message.key.columns+`>>
|_n/a_

View File

@ -1362,9 +1362,13 @@ Note: Depending on the `_hashAlgorithm_` used, the `_salt_` selected and the act
|[[oracle-property-tombstones-on-delete]]<<oracle-property-tombstones-on-delete, `+tombstones.on.delete+`>>
|`true`
| Controls whether a tombstone event should be generated after a delete event. +
When `true` the delete operations are represented by a delete event and a subsequent tombstone event. When `false` only a delete event is sent. +
Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted.
|Controls whether a _delete_ event is followed by a tombstone event. +
+
`true` - a delete operation is represented by a _delete_ event and a subsequent tombstone event. +
+
`false` - only a _delete_ event is emitted. +
+
After a source record is deleted, emitting a tombstone event (the default behavior) allows Kafka to completely delete all events that pertain to the key of the deleted row in case {link-kafka-docs}/#compaction[log compaction] is enabled for the topic.
|[[oracle-property-message-key-columns]]<<oracle-property-message-key-columns, `+message.key.columns+`>>
|

View File

@ -2599,13 +2599,13 @@ If the publication already exists, either for all tables or configured with a su
|[[postgresql-property-tombstones-on-delete]]<<postgresql-property-tombstones-on-delete, `+tombstones.on.delete+`>>
|`true`
| Controls whether a tombstone event should be generated after a _delete_ event. +
|Controls whether a _delete_ event is followed by a tombstone event. +
+
`true` - delete operations are represented by a _delete_ event and a subsequent tombstone event. +
`true` - a delete operation is represented by a _delete_ event and a subsequent tombstone event. +
+
`false` - only a _delete_ event is sent. +
`false` - only a _delete_ event is emitted. +
+
After a _delete_ operation, emitting a tombstone event enables Kafka to delete all change event records that have the same key as the deleted row.
After a source record is deleted, emitting a tombstone event (the default behavior) allows Kafka to completely delete all events that pertain to the key of the deleted row in case {link-kafka-docs}/#compaction[log compaction] is enabled for the topic.
|[[postgresql-property-column-truncate-to-length-chars]]<<postgresql-property-column-truncate-to-length-chars, `+column.truncate.to._length_.chars+`>>
|_n/a_

View File

@ -2066,9 +2066,13 @@ Note: Depending on the `_hashAlgorithm_` used, the `_salt_` selected and the act
|[[sqlserver-property-tombstones-on-delete]]<<sqlserver-property-tombstones-on-delete, `+tombstones.on.delete+`>>
|`true`
| Controls whether a tombstone event should be generated after a delete event. +
When `true` the delete operations are represented by a delete event and a subsequent tombstone event. When `false` only a delete event is sent. +
Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted.
|Controls whether a _delete_ event is followed by a tombstone event. +
+
`true` - a delete operation is represented by a _delete_ event and a subsequent tombstone event. +
+
`false` - only a _delete_ event is emitted. +
+
After a source record is deleted, emitting a tombstone event (the default behavior) allows Kafka to completely delete all events that pertain to the key of the deleted row in case {link-kafka-docs}/#compaction[log compaction] is enabled for the topic.
|[[sqlserver-property-column-truncate-to-length-chars]]<<sqlserver-property-column-truncate-to-length-chars, `+column.truncate.to._length_.chars+`>>
|_n/a_

View File

@ -1110,13 +1110,13 @@ The following configuration properties are _required_ unless a default value is
|[[vitess-property-tombstones-on-delete]]<<vitess-property-tombstones-on-delete, `+tombstones.on.delete+`>>
|`true`
| Controls whether a tombstone event should be generated after a _delete_ event. +
|Controls whether a _delete_ event is followed by a tombstone event. +
+
`true` - delete operations are represented by a _delete_ event and a subsequent tombstone event. +
`true` - a delete operation is represented by a _delete_ event and a subsequent tombstone event. +
+
`false` - only a _delete_ event is sent. +
`false` - only a _delete_ event is emitted. +
+
After a _delete_ operation, emitting a tombstone event enables Kafka to delete all change event records that have the same key as the deleted row.
After a source record is deleted, emitting a tombstone event (the default behavior) allows Kafka to completely delete all events that pertain to the key of the deleted row in case {link-kafka-docs}/#compaction[log compaction] is enabled for the topic.
|[[vitess-property-message-key-columns]]<<vitess-property-message-key-columns, `+message.key.columns+`>>
|_empty string_