From b281b3bede8cbb159298e8357a13519908adf0cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vojt=C4=9Bch=20Jur=C3=A1nek?= Date: Tue, 2 Apr 2024 15:29:28 +0200 Subject: [PATCH] DBZ-7632 Apply suggestions from code review Co-authored-by: roldanbob --- debezium-embedded/README.md | 2 +- documentation/modules/ROOT/pages/development/engine.adoc | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/debezium-embedded/README.md b/debezium-embedded/README.md index 8fcba0929..be2182819 100644 --- a/debezium-embedded/README.md +++ b/debezium-embedded/README.md @@ -6,4 +6,4 @@ Not every application needs this level of fault tolerance and reliability, and t This `debezium-embedded` module defines a small library that allows an application to easily configure and run Debezium connectors. -For the guidance how to embed `DebeziumEngine` into your application, possible configuration options and other details, please see [the corresponding part of the Debezium documentation](https://debezium.io/documentation/reference/stable/development/engine.html). \ No newline at end of file +For information about how to embed `DebeziumEngine` into your application, descriptions of the available configuration options, and other details, see the [Debezium Engine documentation](https://debezium.io/documentation/reference/stable/development/engine.html). \ No newline at end of file diff --git a/documentation/modules/ROOT/pages/development/engine.adoc b/documentation/modules/ROOT/pages/development/engine.adoc index 557554043..f6e871b64 100644 --- a/documentation/modules/ROOT/pages/development/engine.adoc +++ b/documentation/modules/ROOT/pages/development/engine.adoc @@ -21,10 +21,12 @@ They still want the same data change events, but prefer to have the connectors s This `debezium-api` module defines a small API that allows an application to easily configure and run {prodname} connectors using {prodname} Engine. Beginning with the 2.6.0 release, {prodname} provides two implementations of the `DebeziumEngine` interface. -The older one, `EmbeddedEngine`, processes all records sequentially and allows to run on one task for given connector. +The older `EmbeddedEngine` implementation runs a single connector that uses only one task. +The connector emits all records sequentially. + This the default implementation. Beginning with the 2.6.0 release, a new `AsyncEmbeddedEngine` implementation is available. -This implementation processes records in multiple threads, and can 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. Both implementations also support the same configuration options. However, the new `AsyncEmbeddedEngine` provides a couple of new configuration options for setting up and fine-tuning parallel processing.