Skip to content
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.

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

Update migration guide with subscription changes #207

Merged
merged 2 commits into from
Oct 24, 2024
Merged
Changes from all commits
Commits
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
50 changes: 50 additions & 0 deletions modules/ROOT/pages/migration/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,56 @@ The minimum Node.js version required to run the Neo4j GraphQL Library is now 20.

The minimum Neo4j version required to run the Neo4j GraphQL Library is now 5.0.0.


=== Removed Non-CDC subscriptions

Support for subscription engines other than `Neo4jGraphQLSubscriptionsCDCEngine` has been dropped.
This means subscriptions only work on databases with Change Data Capture (CDC) enabled. The following engines are no longer supported:

* Neo4jGraphQLSubscriptionsDefaultEngine
* link:https://www.npmjs.com/package/@neo4j/graphql-amqp-subscriptions-engine[Neo4jGraphQLAMQPSubscriptionsEngine]

==== Changed default subscription engine

When setting up the default subscriptions for Neo4jGraphQL, now the production-ready CDC engine is used (`Neo4jGraphQLSubscriptionsCDCEngine`) instead of the previous default engine:

[source, javascript]
----
new Neo4jGraphQL({
typeDefs,
driver,
features: {
subscriptions: true
},
});
----

This means the default subscriptions now require CDC enabled in your database.

==== Removed relationship subscriptions

The subscriptions operations `*RelationshipCreated` and `*RelationshipDeleted` are no longer supported.

For example:

[source, graphql, indent=0]
----
subscription MovieRelationshipDeleted {
movieRelationshipCreated {
movie {
title
}
createdRelationship {
actors {
node {
name
}
}
}
}
}
----

=== Removed the deprecated implicit "some" filter from `@relationship`

The deprecated implicit "some" filter without operator suffix has been removed from `@relationship` in favor of the explicit `_SOME` filter.
Expand Down
Loading