Skip to content

Commit 58b960a

Browse files
committed
Update migration guide with subscription changes
1 parent 915e6ee commit 58b960a

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

modules/ROOT/pages/migration/index.adoc

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

3382
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)