From caae1c1ccc2b1aff8db8337f155139f87cad333b Mon Sep 17 00:00:00 2001 From: roldanbob Date: Mon, 24 Jun 2024 14:10:56 -0400 Subject: [PATCH] DBZ-7968 Replace incorrect Title annotation comments in connector docs --- documentation/modules/ROOT/pages/connectors/informix.adoc | 4 ++-- documentation/modules/ROOT/pages/connectors/mongodb.adoc | 8 ++++---- documentation/modules/ROOT/pages/connectors/mysql.adoc | 4 ++-- documentation/modules/ROOT/pages/connectors/oracle.adoc | 4 ++-- .../modules/ROOT/pages/connectors/postgresql.adoc | 4 ++-- documentation/modules/ROOT/pages/connectors/spanner.adoc | 2 +- .../modules/ROOT/pages/connectors/sqlserver.adoc | 4 ++-- documentation/modules/ROOT/pages/connectors/vitess.adoc | 2 +- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/documentation/modules/ROOT/pages/connectors/informix.adoc b/documentation/modules/ROOT/pages/connectors/informix.adoc index a4099935f..a7692bba7 100644 --- a/documentation/modules/ROOT/pages/connectors/informix.adoc +++ b/documentation/modules/ROOT/pages/connectors/informix.adoc @@ -2472,7 +2472,7 @@ If you start multiple connectors in a cluster, this property is useful for avoid |[[informix-property-streaming-delay-ms]]<> |0 |Specifies the time, in milliseconds, that the connector delays the start of the streaming process after it completes a snapshot. -Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. +Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. Set a delay value that is higher than the value of the {link-kafka-docs}/#connectconfigs_offset.flush.interval.ms[`offset.flush.interval.ms`] property that is set for the Kafka Connect worker. |[[informix-property-snapshot-include-collection-list]]<> @@ -2698,7 +2698,7 @@ The {prodname} Informix connector provides three types of metrics that are in ad // Type: concept // ModuleID: monitoring-debezium-informix-connectors-customized-mbean-names -// Title: Customized names for Db2 connector snapshot and streaming MBean objects +// Title: Customized names for Informix connector snapshot and streaming MBean objects === Customized MBean names include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] diff --git a/documentation/modules/ROOT/pages/connectors/mongodb.adoc b/documentation/modules/ROOT/pages/connectors/mongodb.adoc index f66f45607..084663e04 100644 --- a/documentation/modules/ROOT/pages/connectors/mongodb.adoc +++ b/documentation/modules/ROOT/pages/connectors/mongodb.adoc @@ -195,7 +195,7 @@ Grant the user permission to read the database specified by the connector's xref Regardless of the `capture.scope` setting, the user requires permission to run the MongoDB https://www.mongodb.com/docs/manual/reference/command/hello/[hello] command. .Permission to read the `config.shards` collection -Depending on your {prodname} environment, to enable the connector to perform offset consolidation, you must grant the connector user explicit permission to read the `config.shards` collection. +Depending on your {prodname} environment, to enable the connector to perform offset consolidation, you must grant the connector user explicit permission to read the `config.shards` collection. Permission to read the `config.shards` collection is required for the following connector environments: * Connectors upgraded from {prodname} 2.5 or earlier. @@ -221,7 +221,7 @@ We recommend logical names begin with an alphabetic or underscore character, and [[mongodb-offset-consolidation]] === Offset consolidation -The {prodname} MongoDB connector no longer supports `replica_set` connections to sharded MongoDB deployments. +The {prodname} MongoDB connector no longer supports `replica_set` connections to sharded MongoDB deployments. As a result, the offsets recorded by connector versions that used the `replica_set` connection mode are incompatible with the current version. To minimize the affects of the connection mode change, and to prevent the connector from running unnecessary snapshots, when the connector restarts after the upgrade, it runs a procedure to consolidate offsets. @@ -1913,7 +1913,7 @@ Can be used to avoid snapshot interruptions when starting multiple connectors in |[[mongodb-property-streaming-delay-ms]]<> |0 |Specifies the time, in milliseconds, that the connector delays the start of the streaming process after it completes a snapshot. -Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. +Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. Set a delay value that is higher than the value of the {link-kafka-docs}/#connectconfigs_offset.flush.interval.ms[`offset.flush.interval.ms`] property that is set for the Kafka Connect worker. |[[mongodb-property-snapshot-fetch-size]]<> @@ -2220,7 +2220,7 @@ The {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[{prodname} moni // Type: concept // ModuleID: monitoring-debezium-mongodb-connectors-customized-mbean-names -// Title: Customized names for Db2 connector snapshot and streaming MBean objects +// Title: Customized names for MongoDB connector snapshot and streaming MBean objects === Customized MBean names include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] diff --git a/documentation/modules/ROOT/pages/connectors/mysql.adoc b/documentation/modules/ROOT/pages/connectors/mysql.adoc index 23636cd08..bd69018f4 100644 --- a/documentation/modules/ROOT/pages/connectors/mysql.adoc +++ b/documentation/modules/ROOT/pages/connectors/mysql.adoc @@ -3751,7 +3751,7 @@ The connector might establish JDBC connections at its own discretion, so this pr |[[mysql-property-streaming-delay-ms]]<> |0 |Specifies the time, in milliseconds, that the connector delays the start of the streaming process after it completes a snapshot. -Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. +Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. Set a delay value that is higher than the value of the {link-kafka-docs}/#connectconfigs_offset.flush.interval.ms[`offset.flush.interval.ms`] property that is set for the Kafka Connect worker. |[[mysql-property-snapshot-fetch-size]]<> @@ -3986,7 +3986,7 @@ The {prodname} MySQL connector provides three types of metrics that are in addit // Type: concept // ModuleID: monitoring-debezium-mysql-connectors-customized-mbean-names -// Title: Customized names for Db2 connector snapshot and streaming MBean objects +// Title: Customized names for MySQL connector snapshot and streaming MBean objects === Customized MBean names include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] diff --git a/documentation/modules/ROOT/pages/connectors/oracle.adoc b/documentation/modules/ROOT/pages/connectors/oracle.adoc index 8e6e3d3ed..02f390e3d 100644 --- a/documentation/modules/ROOT/pages/connectors/oracle.adoc +++ b/documentation/modules/ROOT/pages/connectors/oracle.adoc @@ -3804,7 +3804,7 @@ Use this property to prevent snapshot interruptions when you start multiple conn |[[oracle-property-streaming-delay-ms]]<> |0 |Specifies the time, in milliseconds, that the connector delays the start of the streaming process after it completes a snapshot. -Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. +Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. Set a delay value that is higher than the value of the {link-kafka-docs}/#connectconfigs_offset.flush.interval.ms[`offset.flush.interval.ms`] property that is set for the Kafka Connect worker. |[[oracle-property-snapshot-fetch-size]]<> @@ -4244,7 +4244,7 @@ Please refer to the {link-prefix}:{link-debezium-monitoring}#monitoring-debezium // Type: concept // ModuleID: monitoring-debezium-oracle-connectors-customized-mbean-names -// Title: Customized names for Db2 connector snapshot and streaming MBean objects +// Title: Customized names for Oracle connector snapshot and streaming MBean objects === Customized MBean names include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] diff --git a/documentation/modules/ROOT/pages/connectors/postgresql.adoc b/documentation/modules/ROOT/pages/connectors/postgresql.adoc index ee22e13ae..4fef0b70e 100644 --- a/documentation/modules/ROOT/pages/connectors/postgresql.adoc +++ b/documentation/modules/ROOT/pages/connectors/postgresql.adoc @@ -3573,7 +3573,7 @@ become outdated if TOASTable columns are dropped from the table. |[[postgresql-property-streaming-delay-ms]]<> |0 |Specifies the time, in milliseconds, that the connector delays the start of the streaming process after it completes a snapshot. -Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. +Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. Set a delay value that is higher than the value of the {link-kafka-docs}/#connectconfigs_offset.flush.interval.ms[`offset.flush.interval.ms`] property that is set for the Kafka Connect worker. |[[postgresql-property-snapshot-fetch-size]]<> @@ -3787,7 +3787,7 @@ The {prodname} PostgreSQL connector provides two types of metrics that are in ad / Type: concept // ModuleID: monitoring-debezium-postgresql-connectors-customized-mbean-names -// Title: Customized names for Db2 connector snapshot and streaming MBean objects +// Title: Customized names for PostgreSQL connector snapshot and streaming MBean objects === Customized MBean names include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] diff --git a/documentation/modules/ROOT/pages/connectors/spanner.adoc b/documentation/modules/ROOT/pages/connectors/spanner.adoc index 85aa44fa3..b62742608 100644 --- a/documentation/modules/ROOT/pages/connectors/spanner.adoc +++ b/documentation/modules/ROOT/pages/connectors/spanner.adoc @@ -952,7 +952,7 @@ xref:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring docume // Type: concept // ModuleID: monitoring-debezium-spanner-connectors-customized-mbean-names -// Title: Customized names for Db2 connector snapshot and streaming MBean objects +// Title: Customized names for Spanner connector snapshot and streaming MBean objects === Customized MBean names include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] diff --git a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc index a19865d8b..d4d6664b8 100644 --- a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc +++ b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc @@ -3079,7 +3079,7 @@ Can be used to avoid snapshot interruptions when starting multiple connectors in |[[sqlserver-property-streaming-delay-ms]]<> |0 |Specifies the time, in milliseconds, that the connector delays the start of the streaming process after it completes a snapshot. -Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. +Setting a delay interval helps to prevent the connector from restarting snapshots in the event that a failure occurs immediately after the snapshot completes, but before the streaming process begins. Set a delay value that is higher than the value of the {link-kafka-docs}/#connectconfigs_offset.flush.interval.ms[`offset.flush.interval.ms`] property that is set for the Kafka Connect worker. |[[sqlserver-property-snapshot-fetch-size]]<> @@ -3517,7 +3517,7 @@ For information about how to expose the preceding metrics through JMX, see the { // Type: concept // ModuleID: monitoring-debezium-sqlserver-connectors-customized-mbean-names -// Title: Customized names for Db2 connector snapshot and streaming MBean objects +// Title: Customized names for SQL Server connector snapshot and streaming MBean objects [id="customized-mbean-names"] === Customized MBean names diff --git a/documentation/modules/ROOT/pages/connectors/vitess.adoc b/documentation/modules/ROOT/pages/connectors/vitess.adoc index 9b07ff25e..256ccec4a 100644 --- a/documentation/modules/ROOT/pages/connectors/vitess.adoc +++ b/documentation/modules/ROOT/pages/connectors/vitess.adoc @@ -1323,7 +1323,7 @@ xref:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring docume // Type: concept // ModuleID: monitoring-debezium-vitess-connectors-customized-mbean-names -// Title: Customized names for Db2 connector snapshot and streaming MBean objects +// Title: Customized names for Vitess connector snapshot and streaming MBean objects === Customized MBean names include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared]