From d8ed3831188862b8c416a53f7d1f44fceb1e69f1 Mon Sep 17 00:00:00 2001 From: Bob Roldan Date: Wed, 9 Mar 2022 17:37:58 -0500 Subject: [PATCH] DBZ-4014 Warne users not to modify database.server.name --- documentation/modules/ROOT/pages/connectors/db2.adoc | 10 +++++++++- .../modules/ROOT/pages/connectors/mysql.adoc | 8 +++++++- .../modules/ROOT/pages/connectors/oracle.adoc | 9 ++++++++- .../modules/ROOT/pages/connectors/postgresql.adoc | 10 +++++++++- .../modules/ROOT/pages/connectors/sqlserver.adoc | 12 ++++++++++-- .../modules/ROOT/pages/connectors/vitess.adoc | 12 ++++++++++-- 6 files changed, 53 insertions(+), 8 deletions(-) diff --git a/documentation/modules/ROOT/pages/connectors/db2.adoc b/documentation/modules/ROOT/pages/connectors/db2.adoc index 063972617..7d0466e91 100644 --- a/documentation/modules/ROOT/pages/connectors/db2.adoc +++ b/documentation/modules/ROOT/pages/connectors/db2.adoc @@ -2013,7 +2013,15 @@ The following configuration properties are _required_ unless a default value is |[[db2-property-database-server-name]]<> |No default -|Logical name that identifies and provides a namespace for the particular Db2 database server that hosts the database for which {prodname} is capturing changes. Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. The logical name should be unique across all other connectors, since it is used as a topic name prefix for all Kafka topics that receive records from this connector. +|Logical name that identifies and provides a namespace for the particular Db2 database server that hosts the database for which {prodname} is capturing changes. +Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. +The logical name should be unique across all other connectors, since it is used as a topic name prefix for all Kafka topics that receive records from this connector. + + + +[WARNING] +==== +Changing the value of this property disrupts connector operations. +All stored offsets are flushed and the connector must re-consume all of the source data. +==== |[[db2-property-table-include-list]]<> |No default diff --git a/documentation/modules/ROOT/pages/connectors/mysql.adoc b/documentation/modules/ROOT/pages/connectors/mysql.adoc index 6c3fd6405..1bc612e64 100644 --- a/documentation/modules/ROOT/pages/connectors/mysql.adoc +++ b/documentation/modules/ROOT/pages/connectors/mysql.adoc @@ -2338,7 +2338,13 @@ The following configuration properties are _required_ unless a default value is |[[mysql-property-database-server-name]]<> |No default |Logical name that identifies and provides a namespace for the particular MySQL database server/cluster in which {prodname} is capturing changes. The logical name should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. -Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. +Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. + + + +[WARNING] +==== +Changing the value of this property disrupts connector operations. +All stored offsets are flushed and the connector must re-consume all of the source data. +==== |[[mysql-property-database-server-id]]<> |_random_ diff --git a/documentation/modules/ROOT/pages/connectors/oracle.adoc b/documentation/modules/ROOT/pages/connectors/oracle.adoc index 1c8bdfe2b..b31ddc3ea 100644 --- a/documentation/modules/ROOT/pages/connectors/oracle.adoc +++ b/documentation/modules/ROOT/pages/connectors/oracle.adoc @@ -2376,7 +2376,14 @@ endif::product[] |Logical name that identifies and provides a namespace for the Oracle database server from which the connector captures changes. The value that you set is used as a prefix for all Kafka topic names that the connector emits. Specify a logical name that is unique among all connectors in your {prodname} environment. -The following characters are valid: alphanumeric characters, hyphens, dots, and underscores. +The following characters are valid: alphanumeric characters, hyphens, dots, and underscores. + + + +[WARNING] +==== +Changing the value of this property disrupts connector operations. +All stored offsets are flushed and the connector must re-consume all of the source data. +==== + |[[oracle-property-database-connection-adapter]]<> |`logminer` diff --git a/documentation/modules/ROOT/pages/connectors/postgresql.adoc b/documentation/modules/ROOT/pages/connectors/postgresql.adoc index a1eaebfdd..ad2de2019 100644 --- a/documentation/modules/ROOT/pages/connectors/postgresql.adoc +++ b/documentation/modules/ROOT/pages/connectors/postgresql.adoc @@ -2660,7 +2660,15 @@ If the publication already exists, either for all tables or configured with a su |[[postgresql-property-database-server-name]]<> |No default -|Logical name that identifies and provides a namespace for the particular PostgreSQL database server or cluster in which {prodname} is capturing changes. Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. The logical name should be unique across all other connectors, since it is used as a topic name prefix for all Kafka topics that receive records from this connector. +|Logical name that identifies and provides a namespace for the particular PostgreSQL database server or cluster in which {prodname} is capturing changes. +The logical name should be unique across all other connectors, since it is used as a topic name prefix for all Kafka topics that receive records from this connector. +Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. + + + +[WARNING] +==== +Changing the value of this property disrupts connector operations. +All stored offsets are flushed and the connector must re-consume all of the source data. +==== |[[postgresql-property-schema-include-list]]<> |No default diff --git a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc index 01d77f592..c4cb9c74e 100644 --- a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc +++ b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc @@ -2077,8 +2077,16 @@ incompatible with the default configuration with no upgrade or downgrade path: |[[sqlserver-property-database-server-name]]<> |No default -|Logical name that identifies and provides a namespace for the SQL Server database server that you want {prodname} to capture. The logical name should be unique across all other connectors, since it is used as a prefix for all Kafka topic names emanating from this connector. -Only alphanumeric characters, hyphens, dots and underscores must be used. +|Logical name that identifies and provides a namespace for the SQL Server database server that you want {prodname} to capture. +The logical name should be unique across all other connectors, since it is used as the prefix for all Kafka topic names that receive records from this connector. +Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. + + +[WARNING] +==== +Changing the value of this property disrupts connector operations. +All stored offsets are flushed and the connector must re-consume all of the source data. +==== + |[[sqlserver-property-table-include-list]]<> |No default diff --git a/documentation/modules/ROOT/pages/connectors/vitess.adoc b/documentation/modules/ROOT/pages/connectors/vitess.adoc index 2926a5838..fb4e749da 100644 --- a/documentation/modules/ROOT/pages/connectors/vitess.adoc +++ b/documentation/modules/ROOT/pages/connectors/vitess.adoc @@ -908,7 +908,7 @@ a|_n/a_ [[setting-up-vitess]] == Seting up Vitess -{prodname} does not require any specific configuration for use with Vitess. Install Vitess according to the standard instructions in the link:https://vitess.io/docs/get-started/local-docker/[Local Install via Docker] guide, or the link:https://vitess.io/docs/get-started/operator/[Vitess Operator for Kubernetes] guide. +{prodname} does not require any specific configuration for use with Vitess. Install Vitess according to the standard instructions in the link:https://vitess.io/docs/get-started/local-docker/[Local Install via Docker] guide, or the link:https://vitess.io/docs/get-started/operator/[Vitess Operator for Kubernetes] guide. .Checklist @@ -1161,7 +1161,15 @@ If set to `true`, you should also consider setting `vitess.gtid` in the configur |[[vitess-property-database-server-name]]<> | -|Logical name that identifies and provides a namespace for the particular Vitess database server or cluster in which {prodname} is capturing changes. Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. The logical name should be unique across all other connectors, since it is used as a topic name prefix for all Kafka topics that receive records from this connector. +|Logical name that identifies and provides a namespace for the particular Vitess database server or cluster in which {prodname} is capturing changes. +Only alphanumeric characters, hyphens, dots and underscores must be used in the database server logical name. +The logical name should be unique across all other connectors, since it is used as a topic name prefix for all Kafka topics that receive records from this connector. + + + +[WARNING] +==== +Changing the value of this property disrupts connector operations. +All stored offsets are flushed and the connector must re-consume all of the source data. +==== |[[vitess-property-table-include-list]]<> |