DBZ-4272 Document limiations

shichao-an · Nov 30, 2021 · d121b3b · d121b3b
1 parent 2789dd6
commit d121b3b
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/documentation/modules/ROOT/pages/connectors/db2.adoc b/documentation/modules/ROOT/pages/connectors/db2.adoc
@@ -125,6 +125,11 @@ The level of the lock is determined by the `snapshot.isolation.mode` connector
 
 include::{partialsdir}/modules/all-connectors/ref-connector-incremental-snapshot.adoc[leveloffset=+3]
 
+[WARNING]
+====
+The {prodname} connector for Db2 does not support schema changes while an incremental snapshot is running.
+====
+
 // Type: concept
 // Title: How {prodname} Db2 connectors read change-data tables
 [id="how-debezium-db2-connectors-read-change-data-tables"]

diff --git a/documentation/modules/ROOT/pages/connectors/oracle.adoc b/documentation/modules/ROOT/pages/connectors/oracle.adoc
@@ -120,6 +120,11 @@ Note this mode is only safe to be used when it is guaranteed that no schema chan
 
 include::{partialsdir}/modules/all-connectors/ref-connector-incremental-snapshot.adoc[leveloffset=+3]
 
+[WARNING]
+====
+The {prodname} connector for Oracle does not support schema changes while an incremental snapshot is running.
+====
+
 // Type: concept
 // ModuleID: default-names-of-kafka-topics-that-receive-debezium-oracle-change-event-records
 // Title: Default names of Kafka topics that receive {prodname} Oracle change event records

diff --git a/documentation/modules/ROOT/pages/connectors/postgresql.adoc b/documentation/modules/ROOT/pages/connectors/postgresql.adoc
@@ -165,6 +165,12 @@ endif::community[]
 
 include::{partialsdir}/modules/all-connectors/ref-connector-incremental-snapshot.adoc[leveloffset=+3]
 
+[WARNING]
+====
+The {prodname} connector for PostgreSQL does not support schema changes while an incremental snapshot is running.
+If a schema change is performed _before_ the incremental snapshot start but _after_ sending the signal then passthrough config option `database.autosave` is set to `conservative` to correctly process the schema change.
+====
+
 ifdef::community[]
 [[postgresql-custom-snapshot]]
 === Custom snapshotter SPI

diff --git a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc
@@ -133,6 +133,11 @@ From this baseline state, the connector captures subsequent changes as they occu
 
 include::{partialsdir}/modules/all-connectors/ref-connector-incremental-snapshot.adoc[leveloffset=+3]
 
+[WARNING]
+====
+The {prodname} connector for SQL Server does not support schema changes while an incremental snapshot is running.
+====
+
 // Type: concept
 // ModuleID: how-the-debezium-sql-server-connector-reads-change-data-tables
 // Title: How {prodname} SQL Server connectors read change data tables