From 7d8f5dc7ec87a0d8776fb6695b34f7af2cbe8298 Mon Sep 17 00:00:00 2001 From: Jiri Pechanec Date: Fri, 14 Feb 2020 13:45:04 +0100 Subject: [PATCH] DBZ-1704 Document logical name constraints --- documentation/modules/ROOT/pages/connectors/db2.adoc | 1 + documentation/modules/ROOT/pages/connectors/mongodb.adoc | 1 + documentation/modules/ROOT/pages/connectors/oracle.adoc | 1 + documentation/modules/ROOT/pages/connectors/postgresql.adoc | 1 + documentation/modules/ROOT/pages/connectors/sqlserver.adoc | 1 + .../r_mysql-connector-configuration-properties.adoc | 1 + 6 files changed, 6 insertions(+) diff --git a/documentation/modules/ROOT/pages/connectors/db2.adoc b/documentation/modules/ROOT/pages/connectors/db2.adoc index c743a3dce..63c6ed3fb 100644 --- a/documentation/modules/ROOT/pages/connectors/db2.adoc +++ b/documentation/modules/ROOT/pages/connectors/db2.adoc @@ -1371,6 +1371,7 @@ The following configuration properties are _required_ unless a default value is |`database.server.name` | |Logical name that identifies and provides a namespace for the particular Db2 database server being monitored. 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 and underscores should be used. |`database.history.kafka.topic` | diff --git a/documentation/modules/ROOT/pages/connectors/mongodb.adoc b/documentation/modules/ROOT/pages/connectors/mongodb.adoc index b8d8290ba..2d1b3dc8f 100644 --- a/documentation/modules/ROOT/pages/connectors/mongodb.adoc +++ b/documentation/modules/ROOT/pages/connectors/mongodb.adoc @@ -620,6 +620,7 @@ The following configuration properties are _required_ unless a default value is |`mongodb.name` | |A unique name that identifies the connector and/or MongoDB replica set or sharded cluster that this connector monitors. Each server should be monitored by at most one {prodname} connector, since this server name prefixes all persisted Kafka topics emanating from the MongoDB replica set or cluster. +Only alphanumeric characters and underscores should be used. |`mongodb.user` | diff --git a/documentation/modules/ROOT/pages/connectors/oracle.adoc b/documentation/modules/ROOT/pages/connectors/oracle.adoc index 2eadea05f..4870becba 100644 --- a/documentation/modules/ROOT/pages/connectors/oracle.adoc +++ b/documentation/modules/ROOT/pages/connectors/oracle.adoc @@ -1144,6 +1144,7 @@ The following configuration properties are _required_ unless a default value is |`database.server.name` | |Logical name that identifies and provides a namespace for the particular Oracle database server being monitored. 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 and underscores should be used. |`database.history.kafka.topic` | diff --git a/documentation/modules/ROOT/pages/connectors/postgresql.adoc b/documentation/modules/ROOT/pages/connectors/postgresql.adoc index 599ff6db6..5f84a06f5 100644 --- a/documentation/modules/ROOT/pages/connectors/postgresql.adoc +++ b/documentation/modules/ROOT/pages/connectors/postgresql.adoc @@ -1696,6 +1696,7 @@ If the publication already exists (either for all tables or configured with a su |`database.server.name` | |Logical name that identifies and provides a namespace for the particular PostgreSQL database server/cluster being monitored. The logical name should be unique across all other connectors, since it is used as a prefix for all Kafka topic names coming from this connector. +Only alphanumeric characters and underscores should be used. |`schema.whitelist` | diff --git a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc index 95e68a580..d6ebafe84 100644 --- a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc +++ b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc @@ -1358,6 +1358,7 @@ The following configuration properties are _required_ unless a default value is |`database.server.name` | |Logical name that identifies and provides a namespace for the particular SQL Server database server being monitored. 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 and underscores should be used. |`database.history.kafka.topic` | diff --git a/documentation/modules/ROOT/pages/modules/cdc-mysql-connector/r_mysql-connector-configuration-properties.adoc b/documentation/modules/ROOT/pages/modules/cdc-mysql-connector/r_mysql-connector-configuration-properties.adoc index 8c70721f2..9e9e039de 100644 --- a/documentation/modules/ROOT/pages/modules/cdc-mysql-connector/r_mysql-connector-configuration-properties.adoc +++ b/documentation/modules/ROOT/pages/modules/cdc-mysql-connector/r_mysql-connector-configuration-properties.adoc @@ -43,6 +43,7 @@ TIP: The {prodname} MySQL connector supports _pass-through_ configuration when c |`database.server.name` | |Logical name that identifies and provides a namespace for the particular MySQL database server/cluster being monitored. 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 and underscores should be used. |`database.server.id` |_random_