From 2523d70f76afd1241c9e56186d25e4882ffe4d66 Mon Sep 17 00:00:00 2001 From: mfvitale Date: Tue, 5 Dec 2023 15:19:38 +0100 Subject: [PATCH] DBZ-6834 Add docs for incremental.snapshot.watermarking.strategy --- documentation/modules/ROOT/pages/connectors/db2.adoc | 8 ++++++++ .../modules/ROOT/pages/connectors/informix.adoc | 8 ++++++++ .../modules/ROOT/pages/connectors/mongodb.adoc | 11 +++++++++++ .../modules/ROOT/pages/connectors/mysql.adoc | 8 ++++++++ .../modules/ROOT/pages/connectors/oracle.adoc | 8 ++++++++ .../modules/ROOT/pages/connectors/postgresql.adoc | 9 +++++++++ .../modules/ROOT/pages/connectors/sqlserver.adoc | 8 ++++++++ 7 files changed, 60 insertions(+) diff --git a/documentation/modules/ROOT/pages/connectors/db2.adoc b/documentation/modules/ROOT/pages/connectors/db2.adoc index d3258a5f6..0a3880b4d 100644 --- a/documentation/modules/ROOT/pages/connectors/db2.adoc +++ b/documentation/modules/ROOT/pages/connectors/db2.adoc @@ -2752,6 +2752,14 @@ Increasing the chunk size provides greater efficiency, because the snapshot runs However, larger chunk sizes also require more memory to buffer the snapshot data. Adjust the chunk size to a value that provides the best performance in your environment. +|[[db2-property-incremental-snapshot-watermarking-strategy]]<> +|`insert_insert` +|Specify the strategy used for watermarking during an incremental snapshot: + ++ +`insert_insert`: both open and close signal is written into signal data collection. + ++ +`insert_delete`: only open signal is written into signal data collection, the close one will delete the relative open signal. Useful to keep signal data collection size low. + + |[[db2-property-topic-naming-strategy]]<> |`io.debezium.schema.SchemaTopicNamingStrategy` diff --git a/documentation/modules/ROOT/pages/connectors/informix.adoc b/documentation/modules/ROOT/pages/connectors/informix.adoc index 8a80e1c8b..a65c6e338 100644 --- a/documentation/modules/ROOT/pages/connectors/informix.adoc +++ b/documentation/modules/ROOT/pages/connectors/informix.adoc @@ -2391,6 +2391,14 @@ Increasing the chunk size provides greater efficiency, because the snapshot runs However, larger chunk sizes also require more memory to buffer the snapshot data. Adjust the chunk size to a value that provides the best performance in your environment. +|[[informix-property-incremental-snapshot-watermarking-strategy]]<> +|`insert_insert` +|Specify the strategy used for watermarking during an incremental snapshot: + ++ +`insert_insert`: both open and close signal is written into signal data collection. + ++ +`insert_delete`: only open signal is written into signal data collection, the close one will delete the relative open signal. Useful to keep signal data collection size low. + + |[[informix-property-topic-naming-strategy]]<> |`io.debezium.schema.SchemaTopicNamingStrategy` diff --git a/documentation/modules/ROOT/pages/connectors/mongodb.adoc b/documentation/modules/ROOT/pages/connectors/mongodb.adoc index 1817fa744..b6ffb3138 100644 --- a/documentation/modules/ROOT/pages/connectors/mongodb.adoc +++ b/documentation/modules/ROOT/pages/connectors/mongodb.adoc @@ -1967,6 +1967,17 @@ ifdef::product[] Incremental snapshots is a Technology Preview feature for the {prodname} MongoDB connector. endif::product[] +|[[mongodb-property-incremental-snapshot-watermarking-strategy]]<> +|`insert_insert` +|Specify the strategy used for watermarking during an incremental snapshot: + ++ +`insert_insert`: both open and close signal is written into signal data collection. + ++ +`insert_delete`: only open signal is written into signal data collection, the close one will delete the relative open signal. Useful to keep signal data collection size low. + +ifdef::product[] +Incremental snapshots is a Technology Preview feature for the {prodname} MongoDB connector. +endif::product[] + |[[mongodb-property-topic-naming-strategy]]<> |`io.debezium.schema.DefaultTopicNamingStrategy` |The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc., defaults to `DefaultTopicNamingStrategy`. diff --git a/documentation/modules/ROOT/pages/connectors/mysql.adoc b/documentation/modules/ROOT/pages/connectors/mysql.adoc index b4cf2eda9..fbbbb4034 100644 --- a/documentation/modules/ROOT/pages/connectors/mysql.adoc +++ b/documentation/modules/ROOT/pages/connectors/mysql.adoc @@ -3400,6 +3400,14 @@ Increasing the chunk size provides greater efficiency, because the snapshot runs However, larger chunk sizes also require more memory to buffer the snapshot data. Adjust the chunk size to a value that provides the best performance in your environment. +|[[mysql-property-incremental-snapshot-watermarking-strategy]]<> +|`insert_insert` +|Specify the strategy used for watermarking during an incremental snapshot: + ++ +`insert_insert`: both open and close signal is written into signal data collection. + ++ +`insert_delete`: only open signal is written into signal data collection, the close one will delete the relative open signal. Useful to keep signal data collection size low. + + ifdef::community[] |[[mysql-property-read-only]]<> |`false` diff --git a/documentation/modules/ROOT/pages/connectors/oracle.adoc b/documentation/modules/ROOT/pages/connectors/oracle.adoc index e27058b66..2595f56d1 100644 --- a/documentation/modules/ROOT/pages/connectors/oracle.adoc +++ b/documentation/modules/ROOT/pages/connectors/oracle.adoc @@ -3738,6 +3738,14 @@ Increasing the chunk size provides greater efficiency, because the snapshot runs However, larger chunk sizes also require more memory to buffer the snapshot data. Adjust the chunk size to a value that provides the best performance in your environment. +|[[oracle-property-incremental-snapshot-watermarking-strategy]]<> +|`insert_insert` +|Specify the strategy used for watermarking during an incremental snapshot: + ++ +`insert_insert`: both open and close signal is written into signal data collection. + ++ +`insert_delete`: only open signal is written into signal data collection, the close one will delete the relative open signal. Useful to keep signal data collection size low. + + |[[oracle-property-topic-naming-strategy]]<> |`io.debezium.schema.SchemaTopicNamingStrategy` |The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc., defaults to `SchemaTopicNamingStrategy`. diff --git a/documentation/modules/ROOT/pages/connectors/postgresql.adoc b/documentation/modules/ROOT/pages/connectors/postgresql.adoc index 0ddeca9cf..c0550dfbc 100644 --- a/documentation/modules/ROOT/pages/connectors/postgresql.adoc +++ b/documentation/modules/ROOT/pages/connectors/postgresql.adoc @@ -3505,6 +3505,15 @@ Increasing the chunk size provides greater efficiency, because the snapshot runs However, larger chunk sizes also require more memory to buffer the snapshot data. Adjust the chunk size to a value that provides the best performance in your environment. +|[[postgresql-property-incremental-snapshot-watermarking-strategy]]<> +|`insert_insert` +|Specify the strategy used for watermarking during an incremental snapshot: + + + +`insert_insert`: both open and close signal is written into signal data collection. + + + +`insert_delete`: only open signal is written into signal data collection, the close one will delete the relative open signal. Useful to keep signal data collection size low. + + + |[[postgresql-property-xmin-fetch-interval-ms]]<> |`0` |How often, in milliseconds, the XMIN will be read from the replication slot. diff --git a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc index a01d62fd3..ef5786115 100644 --- a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc +++ b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc @@ -2948,6 +2948,14 @@ Increasing the chunk size provides greater efficiency, because the snapshot runs However, larger chunk sizes also require more memory to buffer the snapshot data. Adjust the chunk size to a value that provides the best performance in your environment. +|[[sqlserver-property-incremental-snapshot-watermarking-strategy]]<> +|`insert_insert` +|Specify the strategy used for watermarking during an incremental snapshot: + ++ +`insert_insert`: both open and close signal is written into signal data collection. + ++ +`insert_delete`: only open signal is written into signal data collection, the close one will delete the relative open signal. Useful to keep signal data collection size low. + + |[[sqlserver-property-max-iteration-transactions]]<> |0 |Specifies the maximum number of transactions per iteration to be used to reduce the memory footprint when streaming changes from multiple tables in a database.