Skip to content

Commit 8fbe956

Browse files
authored
Merge pull request #207 from neo4j/update-subscriptions-migration
Update migration guide with subscription changes
2 parents 0b0e740 + d8f5c7d commit 8fbe956

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

modules/ROOT/pages/migration/index.adoc

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,56 @@ The minimum Node.js version required to run the Neo4j GraphQL Library is now 20.
2828

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

31+
32+
=== Removed Non-CDC subscriptions
33+
34+
Support for subscription engines other than `Neo4jGraphQLSubscriptionsCDCEngine` has been dropped.
35+
This means subscriptions only work on databases with Change Data Capture (CDC) enabled. The following engines are no longer supported:
36+
37+
* Neo4jGraphQLSubscriptionsDefaultEngine
38+
* link:https://www.npmjs.com/package/@neo4j/graphql-amqp-subscriptions-engine[Neo4jGraphQLAMQPSubscriptionsEngine]
39+
40+
==== Changed default subscription engine
41+
42+
When setting up the default subscriptions for Neo4jGraphQL, now the production-ready CDC engine is used (`Neo4jGraphQLSubscriptionsCDCEngine`) instead of the previous default engine:
43+
44+
[source, javascript]
45+
----
46+
new Neo4jGraphQL({
47+
typeDefs,
48+
driver,
49+
features: {
50+
subscriptions: true
51+
},
52+
});
53+
----
54+
55+
This means the default subscriptions now require CDC enabled in your database.
56+
57+
==== Removed relationship subscriptions
58+
59+
The subscriptions operations `*RelationshipCreated` and `*RelationshipDeleted` are no longer supported.
60+
61+
For example:
62+
63+
[source, graphql, indent=0]
64+
----
65+
subscription MovieRelationshipDeleted {
66+
movieRelationshipCreated {
67+
movie {
68+
title
69+
}
70+
createdRelationship {
71+
actors {
72+
node {
73+
name
74+
}
75+
}
76+
}
77+
}
78+
}
79+
----
80+
3181
=== Removed the deprecated implicit "some" filter from `@relationship`
3282

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

0 commit comments

Comments
 (0)