Skip to content

Commit e44a43a

Browse files
committed
Mark Notification API as deprecated
1 parent 8f42612 commit e44a43a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

modules/ROOT/pages/notifications/index.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ After a successful query execution, the Neo4j server sends notifications to prov
77
The driver receives these notifications and sends them to the client, which displays them to the user.
88

99
From version 5.23, Neo4j has a new GqlStatusObject API in addition to the existing Notification API.
10+
The Notification API is deprecated since Neo4j 5.26.
1011
The GqlStatusObject API provides information about the status of a Cypher query or command execution in compliance with the GQL standard.
1112

1213
This page describes both the GQL-status object and the Neo4j Notification frameworks, how they are structured, the objects they provide for notifications, and how to interpret them.
@@ -148,6 +149,7 @@ The following table lists the Neo4j-defined groups of GQLSTATUS codes and their
148149

149150
|===
150151

152+
[role=label--deprecated-5.26]
151153
[[neo4j-notification-object]]
152154
== Neo4j notification object
153155

@@ -244,6 +246,7 @@ The following notification groups exist in Neo4j, ordered by severity:
244246
|
245247
|===
246248

249+
[role=label--deprecated-5.26]
247250
[[notification-internals]]
248251
== Notification internals
249252

@@ -252,7 +255,7 @@ During the handshake process, they agree on using the newest possible Bolt proto
252255
For more information on the Bolt versions supported by different server versions, see the link:https://neo4j.com/docs/bolt/current/bolt-compatibility[Bolt Protocol documentation].
253256

254257
On the server side, notifications are part of the Result Core API.
255-
A method called `getNotifications()` returns a list of server-side notification objects.
258+
A method called `getNotifications()`, which is deprecated since 5.26, returns a list of server-side notification objects.
256259
These notifications are then sent to the driver as success Bolt message metadata.
257260
On the driver side, notifications are part of the ResultSummary API, which has a method called `notifications()` that returns a list of driver-side Notification objects.
258261
The result of the `getCode()` or `code()` methods is known as the Neo4j status code.
@@ -261,6 +264,7 @@ For more information, see <<notification-grouping-and-filtering, Server notifica
261264

262265
From version 5.23, Neo4j has a new GqlStatusObject API in addition to the existing Notification API.
263266
This can be used using the `.getGqlStatusObjects()` method in the Result Core API or by using the latest Neo4j drivers.
267+
The Notification API is deprecated since Neo4j 5.26.
264268

265269
[[server-driver-compatibility]]
266270
== Server-driver version compatibility

0 commit comments

Comments
 (0)