Skip to content

Add cdc source value serialization types #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 4, 2024
Merged

Add cdc source value serialization types #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
06cb766
Add cdc source value serialization types
Emrehzl94 Aug 30, 2024
f5a258b
Add note to specify change_event type required for sink connector
Emrehzl94 Aug 30, 2024
27cb616
Add change log entry for 5.1.0
Emrehzl94 Aug 30, 2024
d56dae3
Remove neo4j.max-retry-attempts
Emrehzl94 Aug 30, 2024
4e5d255
Update cdc value serialisation note
Emrehzl94 Sep 4, 2024
c8629c4
Merge branch 'main' into cdc-value-strategy
ali-ince Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions modules/ROOT/pages/changelog.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

This page lists changes to the {product-name}.

== Version 5.1.0

=== New and updated features

[cols="2",options="header"]
|===
| Feature
| Details

a|
label:feature[]
label:new[]

Added value serialisation strategies for CDC source messages.
a| We've introduced an optional property `neo4j.cdc.topic.$topic.value-strategy`, which specifies how the values of CDC source messages will be serialised. Available options as `CHANGE_EVENT`, `ENTITY_EVENT`.

|===

== Version 5.1.0-rc02

=== New and updated features
Expand Down
8 changes: 8 additions & 0 deletions modules/ROOT/pages/source/configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ One of `SKIP`, `ELEMENT_ID`, `ENTITY_KEYS`, `WHOLE_VALUE`.

Default: `WHOLE_WALUE`

| neo4j.cdc.topic.\{NAME}.value-strategy
| Serialisation strategy for CDC topic key.
One of `CHANGE_EVENT`, `ENTITY_EVENT`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should note that sink connector with one of the CDC strategies require CHANGE_EVENT.


Default: `CHANGE_EVENT`

Note: If you're using a sink connector with one of the CDC strategies, this setting must be configured as `CHANGE_EVENT`.

| neo4j.cdc.poll-duration
| Maximum amount of time Kafka Connect poll request will wait for a change to be received from the database (valid units are: `ms`, `s`, `m`, `h` and `d`; default unit is `s`)

Expand Down
5 changes: 0 additions & 5 deletions modules/ROOT/partials/connector-common-configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,6 @@ Default: `1h` (Driver default)

Default: `30s`

| neo4j.max-retry-attempts
| Maximum number of attempts during the duration specified by `neo4j.max-retry-time`.

Default: `5`

| neo4j.security.encrypted
| Whether encryption is enabled. Only applicable when `bolt` or `neo4j` schemes are used inside `neo4j.uri`.
One of `true`, `false`
Expand Down