From 58b960a3b8a05f4e482fe0ea7efa60366c6e2ed8 Mon Sep 17 00:00:00 2001 From: angrykoala Date: Wed, 23 Oct 2024 16:22:19 +0100 Subject: [PATCH 1/2] Update migration guide with subscription changes --- modules/ROOT/pages/migration/index.adoc | 49 +++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/modules/ROOT/pages/migration/index.adoc b/modules/ROOT/pages/migration/index.adoc index 69ed871e..0bb11cd0 100644 --- a/modules/ROOT/pages/migration/index.adoc +++ b/modules/ROOT/pages/migration/index.adoc @@ -28,6 +28,55 @@ 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 enabled. The following previously supported 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. From d8f5c7d906445ef4ea7841e86ad837dc3d4677d6 Mon Sep 17 00:00:00 2001 From: angrykoala Date: Thu, 24 Oct 2024 10:23:37 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Richard Sill <156673635+rsill-neo4j@users.noreply.github.com> --- modules/ROOT/pages/migration/index.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/migration/index.adoc b/modules/ROOT/pages/migration/index.adoc index 0bb11cd0..2d2364ee 100644 --- a/modules/ROOT/pages/migration/index.adoc +++ b/modules/ROOT/pages/migration/index.adoc @@ -31,7 +31,8 @@ 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 enabled. The following previously supported engines are no longer supported: +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] @@ -51,7 +52,7 @@ new Neo4jGraphQL({ }); ---- -This means the default subscriptions now require CDC enabled in your database +This means the default subscriptions now require CDC enabled in your database. ==== Removed relationship subscriptions