DBZ-7632 Apply suggestions from code review

Co-authored-by: roldanbob <broldan@redhat.com>
This commit is contained in:
Vojtěch Juránek 2024-04-03 21:04:01 +02:00
parent a63d084f3b
commit 936bc33b46

View File

@ -23,12 +23,13 @@ This `debezium-api` module defines a small API that allows an application to eas
Beginning with the 2.6.0 release, {prodname} provides two implementations of the `DebeziumEngine` interface. Beginning with the 2.6.0 release, {prodname} provides two implementations of the `DebeziumEngine` interface.
The older `EmbeddedEngine` implementation runs a single connector that uses only one task. The older `EmbeddedEngine` implementation runs a single connector that uses only one task.
The connector emits all records sequentially. The connector emits all records sequentially.
This the default implementation. This the default implementation.
Beginning with the 2.6.0 release, a new `AsyncEmbeddedEngine` implementation is available. Beginning with the 2.6.0 release, a new `AsyncEmbeddedEngine` implementation is available.
This implementation also runs only a single connector, but it can process records in multiple threads, and run multiple tasks, if the connector supports it (currently only the connectors for SQL Server and MongoDB support running multiple tasks within a single connector). This implementation also runs only a single connector, but it can process records in multiple threads, and run multiple tasks, if the connector supports it (currently only the connectors for SQL Server and MongoDB support running multiple tasks within a single connector).
Because both of these engines implement the same interface and share the same API, the code examples that follow are valid for either engine. Because both of these engines implement the same interface and share the same API, the code examples that follow are valid for either engine.
Both implementations support the same configuration options. Both implementations support the same configuration options.
However, the new `AsyncEmbeddedEngine` provides a couple of new configuration options for setting up and fine-tuning parallel processing. However, the new `AsyncEmbeddedEngine` provides a couple of new configuration options for setting up and fine-tuning parallel processing.
For information about these new configuration options, see the xref:async-engine-properties[Asynchronous Engine Properties]. For information about these new configuration options, see the xref:async-engine-properties[Asynchronous Engine Properties].
To learn more about the motivation behind development of the `AsyncEmbeddedEngine` and about its implementation details, see the https://github.com/debezium/debezium-design-documents/blob/main/DDD-7.md[Asynchronous Embedded Engine design document]. To learn more about the motivation behind development of the `AsyncEmbeddedEngine` and about its implementation details, see the https://github.com/debezium/debezium-design-documents/blob/main/DDD-7.md[Asynchronous Embedded Engine design document].