Skip to content

Add more explanation about payload mode in source query #79

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 5 commits into from
Jul 2, 2025
Merged

Add more explanation about payload mode in source query #79

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
61d0e6a
Update source.query.json-string.json
ali-ince Jul 2, 2025
e3583d5
Explain payload mode in source query section
ali-ince Jul 2, 2025
f95bdcc
Update modules/ROOT/pages/source/query.adoc
ali-ince Jul 2, 2025
3bf1ac8
Apply suggestions from code review
ali-ince Jul 2, 2025
90c9e41
Extract sample jsons into files
ali-ince Jul 2, 2025
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
2 changes: 1 addition & 1 deletion modules/ROOT/examples/docker-data/source.query.json-string.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
"neo4j.query.polling-interval": "1s",
"neo4j.query.polling-duration": "5s"
}
}
}
93 changes: 91 additions & 2 deletions modules/ROOT/pages/source/query.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,98 @@ curl -X POST http://localhost:8083/connectors \
This will create a Kafka Connect source instance that will send change event messages derived by the provided query over to the `my-topic` topic, using your preferred serialization format.
In Control Center, confirm that the Source connector has been created in the Connect tab, under connect-default.

Generated change event messages in this case will have the following structure:
Generated change event messages in this case will have the following structure, which wraps each field into a dedicated structure which is type safe:

[source,json]
----
{"name": <name>, "surname": <surname>, "timestamp": <timestamp>}
{
"name": {
"type": "S",
"B": null,
"I64": null,
"F64": null,
"S": "<name>",
"BA": null,
"TLD": null,
"TLDT": null,
"TLT": null,
"TZDT": null,
"TOT": null,
"TD": null,
"SP": null,
"LB": null,
"LI64": null,
"LF64": null,
"LS": null,
"LTLD": null,
"LTLDT": null,
"LTLT": null,
"LZDT": null,
"LTOT": null,
"LTD": null,
"LSP": null
},
"surname": {
"type": "S",
"B": null,
"I64": null,
"F64": null,
"S": "<surname>",
"BA": null,
"TLD": null,
"TLDT": null,
"TLT": null,
"TZDT": null,
"TOT": null,
"TD": null,
"SP": null,
"LB": null,
"LI64": null,
"LF64": null,
"LS": null,
"LTLD": null,
"LTLDT": null,
"LTLT": null,
"LZDT": null,
"LTOT": null,
"LTD": null,
"LSP": null
},
"timestamp": {
"type": "I64",
"B": null,
"I64": <timestamp>,
"F64": null,
"S": null,
"BA": null,
"TLD": null,
"TLDT": null,
"TLT": null,
"TZDT": null,
"TOT": null,
"TD": null,
"SP": null,
"LB": null,
"LI64": null,
"LF64": null,
"LS": null,
"LTLD": null,
"LTLDT": null,
"LTLT": null,
"LZDT": null,
"LTOT": null,
"LTD": null,
"LSP": null
}
}
----

While the above serialized form of the change message is type safe, it might make the consumer side deserialization logic quite complex and not desired.
In this case, you can configure `neo4j.payload-mode` setting as `COMPACT` and change event messages will instead be structured as;

[source,json]
----
{"name": "<name>", "surname": "<surname>", "timestamp": <timestamp>}
----

Refer to xref:source/payload-mode.adoc[payload mode] for more information about `neo4j.payload-mode` setting, including its limitations.