add requested changes

neo4j · Oct 30, 2024 · 5514521 · 5514521
1 parent 51ed57d
commit 5514521
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/modules/ROOT/pages/source/payload-mode.adoc b/modules/ROOT/pages/source/payload-mode.adoc
@@ -182,4 +182,4 @@ For example, a string field will be represented as:
 
 == Compatibility with Sink Connectors
 
-The `EXTENDED` format was introduced in connector version 5.1.0 to ensure that all data published to Kafka topics adheres to a consistent schema. This prevents issues when a property changes type on the Neo4j side (e.g., a name property changes from integer to string), enabling smooth data processing across connectors and Kafka consumers.
+The `EXTENDED` format was introduced in connector version 5.1.0 to ensure that all data published to Kafka topics adheres to a consistent schema. This prevents issues when a property changes type on the Neo4j side (e.g., a name property changes from integer to string), enabling smooth data processing across connectors and Kafka consumers. When a Neo4j sink connector is fed by a Neo4j source connector, it’s recommended to use `EXTENDED` mode, as the Neo4j sink connector can seamlessly handle the `EXTENDED` data type.
diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc
@@ -25,6 +25,12 @@ It is no longer possible to turn off this behavior in the connector itself, and
 
 * It is now possible to ignore stored offsets by setting `neo4j.ignore-stored-offset` to `true` if required.
 
+* The new `payload.mode` configuration provides options to control the payload structure:
+
+** **`EXTENDED`**: Provides detailed data and type information, ensuring compatibility even if property types change.
+
+** **`COMPACT`**: Provides a simpler, lightweight format with only essential fields, best used when schema compatibility or complex types aren’t needed.
+
 == Sink
 
 * Changes are now applied in the order they are received from Kafka Connect, grouped by their topics.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -182,4 +182,4 @@ For example, a string field will be represented as:

		== Compatibility with Sink Connectors

		The `EXTENDED` format was introduced in connector version 5.1.0 to ensure that all data published to Kafka topics adheres to a consistent schema. This prevents issues when a property changes type on the Neo4j side (e.g., a name property changes from integer to string), enabling smooth data processing across connectors and Kafka consumers.
		The `EXTENDED` format was introduced in connector version 5.1.0 to ensure that all data published to Kafka topics adheres to a consistent schema. This prevents issues when a property changes type on the Neo4j side (e.g., a name property changes from integer to string), enabling smooth data processing across connectors and Kafka consumers. When a Neo4j sink connector is fed by a Neo4j source connector, it’s recommended to use `EXTENDED` mode, as the Neo4j sink connector can seamlessly handle the `EXTENDED` data type.