DBZ-6688 Apply suggestions from code review

Co-authored-by: roldanbob <broldan@redhat.com>
This commit is contained in:
Jiri Pechanec 2023-08-15 12:47:36 +02:00
parent 9bfbb01fb2
commit 3bac4dba23
2 changed files with 7 additions and 4 deletions

View File

@ -157,7 +157,7 @@ CREATE TABLE debezium_signal (id VARCHAR(42) PRIMARY KEY, type VARCHAR(32) NOT N
== Enabling Kafka signaling channel
You can enable the Kafka signaling channel by adding it to the `signal.enabled.channels` configuration property, and then adding the name of the topic that receives signals to the `signal.kafka.topic` property.
A Kafka consumer will be created to consume signals sent on the configured signal topic.
After you enable the signaling channel, a Kafka consumer is created to consume signals that are sent to the configured signal topic.
.Additional configuration available for the consumer
@ -172,7 +172,8 @@ endif::community[]
[NOTE]
====
If you want to trigger an ad hoc incremental snapshot you need to enable also the xref:debezium-signaling-enabling-source-signaling-channel[`source` channel] since it is necessary for internal creating of watermarks for incremental snapshot deduplication.
To use Kafka signaling to trigger ad hoc incremental snapshots for a connector, you must first xref:debezium-signaling-enabling-source-signaling-channel[enable a `source` signaling channel] in the connector configuration.
The source channel implements a watermarking mechanism to deduplicate events that might be captured by an incremental snapshot and then captured again after streaming resumes.
====
=== Message format

View File

@ -11,12 +11,14 @@ The following table describes the Kafka `signal` properties.
|The name of the Kafka topic that the connector monitors for ad hoc signals.
[NOTE]
====
In case automatic topic creation is disabled, you need to create the topic with one partition to preserve the signals ordering.
If {link-prefix}:{ink-topic-auto-creation}#topic-auto-create-config[automatic topic creation] is disabled, you must manually create the required signaling topic.
A signaling topic is required to preserve signal ordering.
The signaling topic must have a single partition.
====
|[[{context}-property-signal-kafka-groupId]]<<{context}-property-signal-kafka-groupId, `+signal.kafka.groupId+`>>
|kafka-signal
|The name of the group id used in the Kafka consumer.
|The name of the group ID that is used by Kafka consumers.
|[[{context}-property-signal-kafka-bootstrap-servers]]<<{context}-property-signal-kafka-bootstrap-servers, `+signal.kafka.bootstrap.servers+`>>
|No default