Skip to content

[Cherry-pick][7.x] Merge pull request #221 from neo4j/update-cdc-docs #243

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 2 commits into from
Mar 11, 2025
Merged

[Cherry-pick][7.x] Merge pull request #221 from neo4j/update-cdc-docs #243

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f49b65d
Update CDC docs to add onlyGraphQLEvents flag
angrykoala Nov 22, 2024
9dbe2dd
Apply suggestions from code review
angrykoala Nov 26, 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
13 changes: 8 additions & 5 deletions modules/ROOT/pages/subscriptions/customize-cdc.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Defaults to 1000ms.
Note that poll time is the period between a finished request and the start of the next.
The actual time it takes for CDC events to trigger the subscription also depends on your network.
* `queryConfig`: An object with the driver query options to be passed to CDC requests.
Use the `db` field to define the target database for CDC.
Use the `db` field to define the target database for CDC.
* `onlyGraphQLEvents`: By default, subscriptions capture all changes done to the database. If this flag is set to `true`, only changes made through GraphQL will trigger the subscription.
Note that if this flag is set to `true`, changes made with a different version of the `@neo4j/graphql` will not trigger subscriptions.

For example:

Expand All @@ -29,17 +31,18 @@ import { Neo4jGraphQL, Neo4jGraphQLSubscriptionsCDCEngine } from '@neo4j/graphql

const engine = new Neo4jGraphQLSubscriptionsCDCEngine({
driver,
pollTime: 5000
pollTime: 5000,
queryConfig: {
database: "neo4j",
},
onlyGraphQLEvents: true
})

const neoSchema = new Neo4jGraphQL({
typeDefs,
driver,
features: {
subscriptions: engine,
queryConfig: {
database: "neo4j",
}
},
});
----
Expand Down