You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/integration/change-data-capture/_index.md
+19-5Lines changed: 19 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,12 +15,19 @@ CDC is intended for developers who need to move Mendix domain model data to exte
15
15
16
16
A CDC service document in Studio Pro defines which entities the runtime should track. On deployment, each tracked entity gets its own Kafka topic. Every time a committed object change occurs — create, update, or delete — the runtime publishes an event to the corresponding topic.
17
17
18
+
Read events are triggered as snapshots during startup or when a stream changes in a way that constitutes a breaking change. Snapshots populate the new topic with the current data of the tracked entity. See [Revisions](/refguide/published-cdc-services/#revisions).
19
+
18
20
The Kafka broker is either the [Mendix Event Broker](/appstore/services/event-broker/) or a Bring Your Own Kafka (BYOK) cluster. For details on configuring BYOK, see the [Mendix Event Broker](/appstore/services/event-broker/) page.
19
21
20
22
To move the streamed data to a destination such as Azure Blob Storage or AWS S3, you configure an [Event Broker Bridge](/appstore/services/event-broker/#manage-mx-broker-bridge) separately in the Event Broker Manager after deployment.
21
23
22
24
## Prerequisites
23
25
26
+
{{% alert color="warning" %}}
27
+
Change Data Capture is not available for Free Apps. A licensed Mendix Cloud environment is required.
28
+
{{% /alert %}}
29
+
30
+
* A licensed Mendix Cloud environment.
24
31
* A [Mendix Event Broker](/appstore/services/event-broker/) license, or a BYOK Kafka cluster configured as described in [Mendix Event Broker](/appstore/services/event-broker/).
25
32
* An [Event Broker Bridge](/appstore/services/event-broker/#manage-mx-broker-bridge) configured in the Event Broker Manager if you want to route CDC events to external storage.
26
33
@@ -49,11 +56,18 @@ When running the app locally, only the bootstrap server address is required:
49
56
50
57
When connecting to a BYOK Kafka cluster, provide the bootstrap server address and credentials for authentication. The supported authentication method is SASL/SCRAM-SHA-512.
51
58
52
-
| Name | Description | Default Value |
53
-
| --- | --- | --- |
54
-
|`Kafka.BootstrapServers`| The address of the Kafka broker, in the format `host:port`. ||
55
-
|`Kafka.Username`| The username for SASL/SCRAM-SHA-512 authentication with the Kafka cluster. ||
56
-
|`Kafka.Password`| The password for SASL/SCRAM-SHA-512 authentication with the Kafka cluster. ||
59
+
| Name | Description | Default Value | Required |
60
+
| --- | --- | --- | --- |
61
+
|`Kafka.BootstrapServers`| The address of the Kafka broker, in the format `host:port`. || true |
62
+
|`Kafka.Username`| The username for SASL/SCRAM-SHA-512 authentication with the Kafka cluster. || true |
63
+
|`Kafka.Password`| The password for SASL/SCRAM-SHA-512 authentication with the Kafka cluster. || true |
64
+
|`EventBroker.Space`| The Event Broker space in which the app is placed. Defines which other applications can exchange events with this app. |`local`||
65
+
|`Datastorage.StartSnapshotMinInterval`| The minimum time, in milliseconds, that must have elapsed since the last snapshot before a new snapshot is triggered on startup. If startup occurs within this window, the snapshot is skipped. |`300000`||
66
+
|`EventBroker.CdcForceSnapshotEntities`| A comma-separated list of entity names (for example, `Module.EntityA,Module.EntityB`) that are always snapshotted on startup, even when no topic change has occurred that would otherwise trigger a snapshot. |||
67
+
|`EventBroker.CdcActiveProducerElectionTopic`| The Kafka topic used for active-producer election among clustered app instances. When set together with `EventBroker.CdcActiveProducerElectionGroupId` and `EventBroker.CdcProducerTransactionId`, instances coordinate to elect a single active CDC producer. If any of the three settings is missing, the app falls back to single-instance mode. |||
68
+
|`EventBroker.CdcActiveProducerElectionGroupId`| The Kafka consumer group ID used for active-producer election. Must be set together with `EventBroker.CdcActiveProducerElectionTopic` and `EventBroker.CdcProducerTransactionId` to enable active-producer election mode. |||
69
+
|`EventBroker.CdcProducerTransactionId`| The transactional ID for the Kafka CDC producer, enabling exactly-once delivery semantics. Must be set together with `EventBroker.CdcActiveProducerElectionTopic` and `EventBroker.CdcActiveProducerElectionGroupId` to enable active-producer election mode. |||
70
+
57
71
58
72
For details on setting up a BYOK cluster with the Mendix Event Broker, see [Mendix Event Broker](/appstore/services/event-broker/).
0 commit comments