From bdacc2a9f2ee19a500c9d80a38457272e5268911 Mon Sep 17 00:00:00 2001 From: Fiore Mario Vitale Date: Wed, 27 Mar 2024 09:49:57 +0100 Subject: [PATCH] DBZ-7497 Document configuration based snapshot mode Co-authored-by: roldanbob --- .../modules/ROOT/pages/connectors/db2.adoc | 12 ++++++------ .../modules/ROOT/pages/connectors/mongodb.adoc | 13 +++++++------ .../modules/ROOT/pages/connectors/mysql.adoc | 14 +++++++------- .../modules/ROOT/pages/connectors/oracle.adoc | 12 ++++++------ .../modules/ROOT/pages/connectors/postgresql.adoc | 12 ++++++------ .../modules/ROOT/pages/connectors/sqlserver.adoc | 12 ++++++------ 6 files changed, 38 insertions(+), 37 deletions(-) diff --git a/documentation/modules/ROOT/pages/connectors/db2.adoc b/documentation/modules/ROOT/pages/connectors/db2.adoc index cdaa67110..cd46dd965 100644 --- a/documentation/modules/ROOT/pages/connectors/db2.adoc +++ b/documentation/modules/ROOT/pages/connectors/db2.adoc @@ -245,7 +245,7 @@ WARNING: Do not use this mode to perform a snapshot if schema changes were commi ifdef::community[] |`configuration_based` -|The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +|Set the snapshot mode to `configuration_based` to control snapshot behavior through the set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -2716,7 +2716,7 @@ WARNING: Do not use this mode to perform a snapshot if schema changes were commi * A previously recorded offset specifies a log position that is not available on the server. ifdef::community[] -`configuration_based`:: The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +`configuration_based`:: With this option, you control snapshot behavior through a set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] @@ -2730,25 +2730,25 @@ endif::community[] ifdef::community[] |[[db2-property-snapshot-mode-configuration-based-snapshot-data]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the data should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table data when it performs a snapshot. endif::community[] ifdef::community[] |[[db2-property-snapshot-mode-configuration-based-snapshot-schema]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes the table schema when it performs a snapshot. endif::community[] ifdef::community[] |[[db2-property-snapshot-mode-configuration-based-start-stream]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the stream should start or not after snapshot. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector begins to stream change events after a snapshot completes. endif::community[] ifdef::community[] |[[db2-property-snapshot-mode-configuration-based-snapshot-on-schema-error]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not in case schema history topic is missing. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table schema in a snapshot if the schema history topic is not available. endif::community[] ifdef::community[] diff --git a/documentation/modules/ROOT/pages/connectors/mongodb.adoc b/documentation/modules/ROOT/pages/connectors/mongodb.adoc index 7d1fd22b6..1dbf7d7d4 100644 --- a/documentation/modules/ROOT/pages/connectors/mongodb.adoc +++ b/documentation/modules/ROOT/pages/connectors/mongodb.adoc @@ -324,7 +324,7 @@ After the snapshot completes, the connector stops, and does not stream event rec ifdef::community[] |`configuration_based` -|The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +|Set the snapshot mode to `configuration_based` to control snapshot behavior through the set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -1999,7 +1999,8 @@ It does not transition to streaming event records for subsequent database change * A previously recorded offset specifies a log position that is not available on the server. ifdef::community[] -`configuration_based`:: The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +`configuration_based`:: With this option, you control snapshot behavior through a set of connector properties that have the prefix 'snapshot.mode.configuration.based'. + endif::community[] ifdef::community[] @@ -2012,25 +2013,25 @@ endif::community[] ifdef::community[] |[[mongodb-property-snapshot-mode-configuration-based-snapshot-data]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the data should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table data when it performs a snapshot. endif::community[] ifdef::community[] |[[mongodb-property-snapshot-mode-configuration-based-snapshot-schema]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes the table schema when it performs a snapshot. endif::community[] ifdef::community[] |[[mongodb-property-snapshot-mode-configuration-based-start-stream]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the stream should start or not after snapshot. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector begins to stream change events after a snapshot completes. endif::community[] ifdef::community[] |[[mongodb-property-snapshot-mode-configuration-based-snapshot-on-schema-error]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not in case schema history topic is missing. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table schema in a snapshot if the schema history topic is not available. endif::community[] ifdef::community[] diff --git a/documentation/modules/ROOT/pages/connectors/mysql.adoc b/documentation/modules/ROOT/pages/connectors/mysql.adoc index 299cc3c8d..c863b9c84 100644 --- a/documentation/modules/ROOT/pages/connectors/mysql.adoc +++ b/documentation/modules/ROOT/pages/connectors/mysql.adoc @@ -699,7 +699,7 @@ WARNING: Do not use this mode to perform a snapshot if schema changes were commi ifdef::community[] |`configuration_based` -|The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +|Set the snapshot mode to `configuration_based` to control snapshot behavior through the set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -3517,7 +3517,7 @@ This option is under consideration for future deprecation, in favor of the `no_d * A previously recorded offset specifies a binlog position or GTID that is not available on the server. ifdef::community[] -`configuration_based`:: The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +`configuration_based`:: With this option, you control snapshot behavior through a set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -3527,31 +3527,31 @@ endif::community[] ifdef::community[] |[[mysql-property-snapshot-mode-configuration-based-snapshot-data]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the data should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table data when it performs a snapshot. endif::community[] ifdef::community[] |[[mysql-property-snapshot-mode-configuration-based-snapshot-schema]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes the table schema when it performs a snapshot. endif::community[] ifdef::community[] |[[mysql-property-snapshot-mode-configuration-based-start-stream]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the stream should start or not after snapshot. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector begins to stream change events after a snapshot completes. endif::community[] ifdef::community[] |[[mysql-property-snapshot-mode-configuration-based-snapshot-on-schema-error]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not in case schema history topic is missing. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table schema in a snapshot if the schema history topic is not available. endif::community[] ifdef::community[] |[[mysql-property-snapshot-mode-configuration-based-snapshot-on-data-error]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the data should be snapshotted or not in case data is no more present on db log. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table data in a snapshot in the event that data is no longer available in the transaction log. endif::community[] ifdef::community[] diff --git a/documentation/modules/ROOT/pages/connectors/oracle.adoc b/documentation/modules/ROOT/pages/connectors/oracle.adoc index 9094cbdde..a04ec1a39 100644 --- a/documentation/modules/ROOT/pages/connectors/oracle.adoc +++ b/documentation/modules/ROOT/pages/connectors/oracle.adoc @@ -207,7 +207,7 @@ WARNING: Do not use this mode to perform a snapshot if schema changes were commi ifdef::community[] |`configuration_based` -|The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +|Set the snapshot mode to `configuration_based` to control snapshot behavior through the set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -3165,7 +3165,7 @@ After the snapshot is complete, the connector continues to read change events fr * A previously recorded offset specifies a log position that is not available on the server. ifdef::community[] -`configuration_based`:: The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +`configuration_based`:: With this option, you control snapshot behavior through a set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -3177,25 +3177,25 @@ For more information, see the xref:oracle-connector-snapshot-mode-options[table ifdef::community[] |[[oracle-property-snapshot-mode-configuration-based-snapshot-data]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the data should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table data when it performs a snapshot. endif::community[] ifdef::community[] |[[oracle-property-snapshot-mode-configuration-based-snapshot-schema]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes the table schema when it performs a snapshot. endif::community[] ifdef::community[] |[[oracle-property-snapshot-mode-configuration-based-start-stream]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the stream should start or not after snapshot. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector begins to stream change events after a snapshot completes. endif::community[] ifdef::community[] |[[oracle-property-snapshot-mode-configuration-based-snapshot-on-schema-error]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not in case schema history topic is missing. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table schema in a snapshot if the schema history topic is not available. endif::community[] ifdef::community[] diff --git a/documentation/modules/ROOT/pages/connectors/postgresql.adoc b/documentation/modules/ROOT/pages/connectors/postgresql.adoc index a43057a2a..52e9ae001 100644 --- a/documentation/modules/ROOT/pages/connectors/postgresql.adoc +++ b/documentation/modules/ROOT/pages/connectors/postgresql.adoc @@ -196,7 +196,7 @@ Use this snapshot mode only when you know that all data of interest is still ref ifdef::community[] |`configuration_based` -|The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +|Set the snapshot mode to `configuration_based` to control snapshot behavior through the set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -3310,7 +3310,7 @@ Use this snapshot mode only when you know all data of interest is still reflecte * A previously recorded offset specifies a log position that is not available on the server. ifdef::community[] -`configuration_based`:: The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +`configuration_based`:: With this option, you control snapshot behavior through a set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -3322,25 +3322,25 @@ For more information, see the xref:#postgresql-connector-snapshot-mode-options[t ifdef::community[] |[[postgresql-property-snapshot-mode-configuration-based-snapshot-data]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the data should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table data when it performs a snapshot. endif::community[] ifdef::community[] |[[postgresql-property-snapshot-mode-configuration-based-snapshot-schema]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes the table schema when it performs a snapshot. endif::community[] ifdef::community[] |[[postgresql-property-snapshot-mode-configuration-based-start-stream]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the stream should start or not after snapshot. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector begins to stream change events after a snapshot completes. endif::community[] ifdef::community[] |[[postgresql-property-snapshot-mode-configuration-based-snapshot-on-schema-error]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not in case schema history topic is missing. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table schema in a snapshot if the schema history topic is not available. endif::community[] ifdef::community[] diff --git a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc index 57ea3746d..2eb47c9bf 100644 --- a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc +++ b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc @@ -228,7 +228,7 @@ WARNING: Do not use this mode to perform a snapshot if schema changes were commi ifdef::community[] |`configuration_based` -|The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +|Set the snapshot mode to `configuration_based` to control snapshot behavior through the set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -2888,7 +2888,7 @@ WARNING: Do not use this mode to perform a snapshot if schema changes were commi * A previously recorded offset specifies a log position that is not available on the server. ifdef::community[] -`configuration_based`:: The `configuration_based` snapshot mode allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'. +`configuration_based`:: With this option, you control snapshot behavior through a set of connector properties that have the prefix 'snapshot.mode.configuration.based'. endif::community[] ifdef::community[] @@ -2901,25 +2901,25 @@ endif::community[] ifdef::community[] |[[sqlserver-property-snapshot-mode-configuration-based-snapshot-data]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the data should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table data when it performs a snapshot. endif::community[] ifdef::community[] |[[sqlserver-property-snapshot-mode-configuration-based-snapshot-schema]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes the table schema when it performs a snapshot. endif::community[] ifdef::community[] |[[sqlserver-property-snapshot-mode-configuration-based-start-stream]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the stream should start or not after snapshot. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector begins to stream change events after a snapshot completes. endif::community[] ifdef::community[] |[[sqlserver-property-snapshot-mode-configuration-based-snapshot-on-schema-error]]<> |false -|When `snapshot.mode` is set as `configuration_based`, this setting permits to specify whenever the schema should be snapshotted or not in case schema history topic is missing. +|If the `snapshot.mode` is set to `configuration_based`, set this property to specify whether the connector includes table schema in a snapshot if the schema history topic is not available. endif::community[] ifdef::community[]