Migration to 6.0.0
This is the documentation of the GraphQL Library version 6. For the long-term support (LTS) version 5, refer to GraphQL Library version 5 LTS. |
This page lists all breaking changes from the Neo4j GraphQL Library version 5.x to 6.x and how to update it.
How to update
To update your Neo4j GraphQL Library, use npm or the package manager of choice:
npm update @neo4j/graphql
Breaking changes
Here is a list of all the breaking changes from version 5.0.0 to 6.0.0.
Changed minimum Node.js version to 20.0.0
The minimum Node.js version required to run the Neo4j GraphQL Library is now 20.0.0.
Changed minimum Neo4j version to 5.0.0
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
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:
new Neo4jGraphQL({
typeDefs,
driver,
features: {
subscriptions: true
},
});
This means the default subscriptions now require CDC enabled in your database.
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.
Before | Now |
---|---|
|
|
Removed invalid filters in aggregation filter inputs
In previous versions of the library, the input used for aggregation filters contained filters that did not rely on aggregating functions. These filters were deprecated in previous library versions and are removed from the schema.
To see the aggregating functions supported on filtering refer to Aggregation filtering,
Removed string aggregation filters not using _LENGTH
Since string aggregations are computed using length, they now require the _LENGTH
suffix for all string aggregation filters.
Before | Now |
---|---|
|
|
Removed the deprecated options
argument from assertIndexesAndConstraints
The deprecated options
argument from the assertIndexesAndConstraints
utility has been removed.
Database migrations are outside of the scope of the Neo4j GraphQL Library, and all indexes and constraints will have to be managed manually.
Removed top-level arguments that are not update
from the top-level update
The top-level update
mutation now only accepts the update
argument.
The following nested operations have been moved into the update
argument:
-
create
-
delete
-
connect
-
disconnect
-
connectOrCreate
Before | Now |
---|---|
|
|
Changed the sort argument for interfaces connection fields
The sort argument for interfaces connection fields is now a list of non-nullable elements.
Before | Now |
---|---|
|
|
The deprecated _NOT
filters are no longer supported
The following deprecated NOT
filters are removed from the schema since they are no longer supported:
-
_NOT
-
_NOT_CONTAINS
-
_NOT_ENDS_WITH
-
_NOT_IN
-
_NOT_STARTS_WITH
-
_NOT_INCUDES
-
node_NOT
-
edge_NOT
To achieve the same in version 6.x of the GraphQL Library, use the boolean NOT
operator instead.
Before | Now |
---|---|
|
|
The deprecated _NOT
on @relationship
filters are no longer supported
The following deprecated _NOT
filters on @relationship
are removed and no longer supported:
-
actors_NOT
-
actorsConnection_NOT
To achieve the same in version 6.x of the GraphQL Library, use the NONE
quantifier.
Before | Now |
---|---|
|
|
Removed the bookmark field from the schema
The bookmark field has been removed from the mutation info
responses (CreateInfo
, UpdateInfo
, DeleteInfo
) as it is no longer required.
Changed the excludeDeprecatedFields
setting in the Neo4jFeaturesSettings
As in version 6.x many of the deprecated fields have been removed, the excludeDeprecatedFields
setting has been modified to reflect these changes.
The following fields have been removed:
-
bookmark
-
negationFilters
-
arrayFilters
-
stringAggregation
-
aggregationFilters
-
nestedUpdateOperationsFields
The following fields have been added:
-
implicitEqualFilters
-
deprecatedOptionsArgument
-
directedArgument
Removed some @cypher
fields from the sort argument
The following @cypher
field types have been removed from the sort
argument because they are not usable as sort fields:
-
@cypher
fields with non-nullable arguments. -
@cypher
fields with non-sortable type likeNode
,List
etc.
Removed connectComponentsPlanner
from cypherQueryOptions
Following the deprecation of the connectComponentsPlanner
, the field is no longer accepted in the GraphQL context and is removed from the cypherQueryOptions
object.
Additions
Added the _EQ
filter as an alternative to the deprecated implicit equal filters
The count_EQ
filter is now available as an alternative to the deprecated count
filter.
Before | Now |
---|---|
|
|
Deprecations and warnings
Removed the Object Graph Mapper (OGM)
The OGM is discontinued with version 6.0.0 of the GraphQL Library. Version 5 (LTS) is the last version to feature the OGM.
Implicit equality filters are deprecated
The following implicit equality filters are deprecated:
-
{ name: "Keanu" }
-
{ count: 10 }
You can achieve the same by using { name_EQ: "Keanu" }
and { count_EQ: 10 }
.
The deprecated quality filters will be removed in version 7.x.
Before | Now |
---|---|
|
|
@node
will have to be explicitly defined
In the future, types without the @node
directive will no longer be treated as Neo4j nodes.
In version 6.0.0, it’s not required to specify every GraphQL type representing a Neo4j node with the @node
directive, however it’s recommended to do so and a warning is raised if you don’t.
There are genuine cases in which a @node
should not be used, e.g., for types returned by @cypher fields which are not Neo4j nodes.
Before | Now |
---|---|
|
|
Deprecated the implicit equality filters
Previously, if a field was present in a filter without specifying the operator, it was treated as an equality filter.
This behavior is now deprecated and will be removed in the future.
Use the _EQ
filter instead.
Before | Now |
---|---|
|
|
Deprecated pagination options
argument
The options
argument in query and @relationship
fields is deprecated and will be removed in the future.
Use the limit
, offset
and sort
arguments instead.
Before | Now |
---|---|
|
|
Deprecated directed
argument in @relationship
fields
The directed
argument was used to change the query direction of the relationship field at the query time, for instance:
{
movies {
title
actors(directed: false) {
name
}
}
}
The directed
argument in @relationship
fields is deprecated and will be removed in the future.
Configure the query direction via the queryDirection
and direction
arguments of the @relationship
directive instead.
Deprecated @relationship.queryDirection
_DEFAULT
and _ONLY
options
Following the deprecation of the directed
argument, the values accepted by the @relationship.queryDirection
have changed:
-
DEFAULT_DIRECTED
is deprecated. -
DEFAULT_UNDIRECTED
is deprecated. -
DIRECTED_ONLY
is renamed toDIRECTED
. -
UNDIRECTED_ONLY
is renamed toUNDIRECTED
.
A warning is raised if you use a deprecated value.