DBZ-4014 Warne users not to modify database.server.name

This commit is contained in:
Bob Roldan 2022-03-09 17:37:58 -05:00 committed by Gunnar Morling
parent ba3438c860
commit d8ed383118
6 changed files with 53 additions and 8 deletions

View File

@ -2013,7 +2013,15 @@ The following configuration properties are _required_ unless a default value is
|[[db2-property-database-server-name]]<<db2-property-database-server-name, `+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]]<<db2-property-table-include-list, `+table.include.list+`>>
|No default

View File

@ -2338,7 +2338,13 @@ The following configuration properties are _required_ unless a default value is
|[[mysql-property-database-server-name]]<<mysql-property-database-server-name, `+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]]<<mysql-property-database-server-id, `+database.server.id+`>>
|_random_

View File

@ -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]]<<oracle-property-database-connection-adapter, `+database.connection.adapter+`>>
|`logminer`

View File

@ -2660,7 +2660,15 @@ If the publication already exists, either for all tables or configured with a su
|[[postgresql-property-database-server-name]]<<postgresql-property-database-server-name, `+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]]<<postgresql-property-schema-include-list, `+schema.include.list+`>>
|No default

View File

@ -2077,8 +2077,16 @@ incompatible with the default configuration with no upgrade or downgrade path:
|[[sqlserver-property-database-server-name]]<<sqlserver-property-database-server-name, `+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]]<<sqlserver-property-table-include-list, `+table.include.list+`>>
|No default

View File

@ -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]]<<vitess-property-database-server-name, `+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]]<<vitess-property-table-include-list, `+table.include.list+`>>
|