You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/notifications/index.adoc
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ After a successful query execution, the Neo4j server sends notifications to prov
7
7
The driver receives these notifications and sends them to the client, which displays them to the user.
8
8
9
9
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.
10
11
The GqlStatusObject API provides information about the status of a Cypher query or command execution in compliance with the GQL standard.
11
12
12
13
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
148
149
149
150
|===
150
151
152
+
[role=label--deprecated-5.26]
151
153
[[neo4j-notification-object]]
152
154
== Neo4j notification object
153
155
@@ -244,6 +246,7 @@ The following notification groups exist in Neo4j, ordered by severity:
244
246
|
245
247
|===
246
248
249
+
[role=label--deprecated-5.26]
247
250
[[notification-internals]]
248
251
== Notification internals
249
252
@@ -252,7 +255,7 @@ During the handshake process, they agree on using the newest possible Bolt proto
252
255
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].
253
256
254
257
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.
256
259
These notifications are then sent to the driver as success Bolt message metadata.
257
260
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.
258
261
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
261
264
262
265
From version 5.23, Neo4j has a new GqlStatusObject API in addition to the existing Notification API.
263
266
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.
0 commit comments