Further updates based on feedback

Author: renetapopova

modules/ROOT/pages/changelogs.adoc

@@ -1,15 +1,8 @@
 :description: This page lists all changes to status codes per Neo4j version.
 = Changes to status codes per Neo4j version
 
-== Neo4j 5.26
-
-**Changed:**
-Using differently ordered return items in a `UNION [ALL]` clause has been undeprecated following cost-benefit analysis and valuable user feedback.
-
 == Neo4j 5.25
 
-**New:**
-
 Starting from 5.25, the query log includes the GQL error information under the JSON object `errorInfo`.
 For more information, see link:https://neo4j.com/docs/operations-manual/current/monitoring/logging/#gql-error-information[Operations Manual -> GQL error information].
 

modules/ROOT/pages/errors/all-errors.adoc

@@ -2,13 +2,13 @@
 
 
 [[neo4j-errors]]
-= List of Neo4j codes
+= List of Neo4j error codes
 
 This page lists the current Neo4j error codes, which will be replaced by xref:errors/gql-errors.adoc[GQLSTATUS error codes] in the future.
 
 Error codes are returned by the server when the execution of a query fails.
 They always have the severity level `ERROR`.
-Errors are grouped based on the type of the Neo4j status code:
+Errors are grouped based on the type of the Neo4j code:
 
 Client errors::
 These errors are caused by the client (user input or user application) and are usually related to the request itself.
@@ -17,11 +17,11 @@ The Neo4j codes for client errors have the prefix `Neo.ClientError`.
 Transient errors::
 These errors are detected by the server and are usually related to some kind of database unavailability, such as limits reached, out-of-memory, timeouts, etc.
 The error can be temporary, and the request could succeed if retried.
-The Neo4j status codes for transient errors have the prefix Neo.`TransientError`.
+The Neo4j codes for transient errors have the prefix Neo.`TransientError`.
 
 Database errors::
 These errors are caused by the database and are usually related to the database state.
-The Neo4j status codes for database errors have the prefix `Neo.DatabaseError`.
+The Neo4j codes for database errors have the prefix `Neo.DatabaseError`.
 
 This page contains lists of all Neo4j errors, grouped by type.
 

modules/ROOT/pages/errors/index.adoc

@@ -3,31 +3,37 @@
 = Server errors
 
 The Neo4j DBMS returns a server error to indicate that the outcome of a Cypher query or command execution is unsuccessful.
+The driver receives these erors and sends them to the Neo4j tools (e.g. Browser, Bloom, Cypher Shell) or the user application, which display them to the user.
 
-Starting from version 5.25, the Neo4j error codes have an additional GQL-status object along with the Neo4j exception that provides information about the status of a Cypher query or command execution in compliance with the link:https://www.iso.org/standard/76120.html[ISO/IEC 39075:2024(en) - Information technology - Database languages - GQL Standard].
+Starting from version 5.26, the Neo4j error codes have an additional GQL-status object along with the Neo4j exception that provides information about the status of a Cypher query or command execution in compliance with the link:https://www.iso.org/standard/76120.html[ISO/IEC 39075:2024(en) - Information technology - Database languages - GQL Standard].
+This additional GQL-status object is also displayed in the query log from Neo4j 5.25.
+For more information, see link:https://neo4j.com/docs/operations-manual/current/monitoring/logging/#gql-error-information[Operations Manual -> GQL error information].
 
 [NOTE]
 ====
-This additional GQL-status object is currently displayed only in the query log.
-For more information, see link:https://neo4j.com/docs/operations-manual/current/monitoring/logging/#gql-error-information[Operations Manual -> GQL error information].
+The default GQLSTATUS code 50N42 is returned when an exception does not have a GQL-status object.
+Starting from Neo4j 5.25, we started adding GQL objects to exceptions.
+Therefore, you can expect many 50N42 codes during this transition period.
+However, it is important not to rely on this default code, as future Neo4j versions might change it by adding an appropriate GQL object to the exception.
+Additionally, GQL codes for external procedures are not yet stable.
 ====
 
-This page describes the GQL-status object and the Neo4j error frameworks, their structure, the objects they provide for errors, and how to interpret them.
-It also explains the error internals and the server-driver compatibility for both the GQLSTATUS and  errors.
+This page describes the GQL-status and the Neo4j-status object frameworks for errors, their structure, the objects they provide for errors, and how to interpret them.
+It also explains the error internals and the server-driver compatibility for both the GQLSTATUS and errors.
 
 [role=label--version-5.25]
 [[gqlstatus-error-object]]
 == GQL-status error object
 
-In the GQL-status object framework, errors are an implementation-defined subset of the GQL-status objects that cover exceptions.
-
-In GQL, the execution of a query from user to server always has an outcome, called the _execution outcome_.
-The execution outcome is a list of GQL-status objects ordered by the following precedence rules:
+In the GQL-status object framework, when a user executes a query to the server, it always produces a result known as the _execution outcome_.
+If an error occurs during execution, the outcome is recorded as an exception condition, indicating a failed outcome with no result.
+The execution outcome for errors is represented as a list of GQL-status objects with a failed outcome, which are organized according to the following precedence rules:
 
 . Every exception that results in a transaction rollback takes precedence over other exceptions.
 . Every exception takes precedence over any completion condition.
+For completion conditions, see the xref:notifications/index.adoc#gqlstatus-notification-object[GQL-status notification object].
 
-The GQL-status object also includes the Neo4j-specific information, such as the severity level and the error classification.
+The GQL-status object also includes Neo4j-specific information, such as severity level and error classification.
 
 Each GQL-status object consists of the following fields:
 
@@ -39,10 +45,11 @@ a| A 5-character string that is the concatenation of a 2-character class code fo
 |StatusDescription
 a| A human-readable description of the GQLSTATUS, which consists of a condition, a subcondition, and an optional additional text about the condition.
 The condition and subcondition are textual representations of the class and subclass codes, respectively.
+The format is `error: condition - subcondition. AdditionalInfo`.
 The subcondition for the subclass 000 is empty.
 | DiagnosticRecord
 a| Extra information about the status, given as key-value pairs, both on the server and driver side.
-To retrieve the full diagnostic record, you can use the `diagnosticRecord()` method on both the server and driver sides.
+To retrieve the full diagnostic record, you can use the `diagnosticRecord()` on the server side or the corresponding method on the driver sides.
 Additional helper methods are exposed for some useful fields.
 [cols="<1s,<4"]
 !===
@@ -57,16 +64,15 @@ Additional helper methods are exposed for some useful fields.
 !===
 |===
 
-A GQL-status error object can also contain an optional wrapped GQL-status object.
-This wrapped object is referred to as a `cause` and used to provide additional, more specific diagnostic information.
+A GQL-status error object can also contain an optional GQL-status object that represents the cause of the error and is used to provide additional, more specific diagnostic information.
 
 [[gqlstatus-neo4j-defined-codes]]
 == Classes of GQLSTATUS error codes
 
 The GQLSTATUS codes are divided into classes and subclasses.
 The class code is a 2-character string that indicates the general condition of the status, such as connection exception, data exception, etc.
 The subclass code is a 3-character string that provides more detailed information about the condition.
-The Neo4j-define subclasses start with N, followed by a 2-digit number, while the ones that do not start with N are standard-defined subclasses.
+//Currently, the Neo4j-defined subclasses start with N or I, followed by a 2-digit number, while the standard-defined subclasses start with 0-4 or A, B, C, D, E, F, G, or H and a 2-digit number.
 
 The following table lists the GQLSTATUS classes and their meanings:
 
@@ -94,10 +100,10 @@ The following table lists the GQLSTATUS classes and their meanings:
 | procedure exception
 |===
 
-[[-error-object]]
-== Neo4j error object
+[[neo4j-error-object]]
+== Neo4j-status error object
 
-The Neo4j  error object contains diagnostic information representing the *unsuccessful* outcome of a Cypher query or command execution, including severity, status code, category, description, message, and position in the query text where the error is relevant.
+The Neo4j-status object for errors contains diagnostic information representing the *unsuccessful* outcome of a Cypher query or command execution, including severity, status code, category, description, message, and position in the query text where the error is relevant.
 Depending on the application, some of the fields from the error object might not be visible.
 
 The error object consists of the following fields:
@@ -164,8 +170,8 @@ Most of these implement the `HasStatus` interface, which means they have a statu
 
 On the server side, an exception contains normal Java constructors and methods like `getMessage()`,  `getCause()`, etc., and additionally the `status()` method from the `HasStatus` API, which returns the status code.
 
-Starting from 5.25, the exceptions also get new compulsary fields for `gqlStatus`, `statusDescription`,  `diagnosticRecord`, and an optional field for `cause`.
-The cause field is a wrapped underlying Neo4j exception, which in turn has its own GQLSTATUS, statusdescription, diagnostic record, and message. +
+The exceptions also get new compulsary fields for `gqlStatus`, `statusDescription`,  `diagnosticRecord`, and an optional field for `cause`.
+The cause field in turn has its own GQLSTATUS, statusdescription, diagnostic record, and message. +
 The `getMessage()` method is kept as Java exceptions inherently have this method.
 And a new classification field is added to cover the division of client errors, transient errors, and database errors, which today is part of the Neo4j code.
 All of these fields construct the GQLSTATUS object, which is sent to the driver as part of the Failure Bolt message.
@@ -186,18 +192,9 @@ As the clients can have separate driver versions, they may have different error
 
 In Neo4j 5.25, the default JSON template for the query log is updated to include `errorInfo` entry.
 This entry contains `GQLSTATUS`, `statusDescription`, `classification`, `position` (if applicable), and `cause` (if applicable) with the same entries.
-The `failureReason` entry is deprecated from 5.26.
-
-[NOTE]
-====
-The default GQLSTATUS code 50N42 is returned when an exception does not have a GQL-status object.
-Starting from Neo4j 5.25, we started adding GQL objects to exceptions.
-Therefore, you can expect many 50N42 codes during this transition period.
-However, it is important not to rely on this default code, as future Neo4j versions might change it by adding an appropriate GQL object to the exception.
-Additionally, GQL codes for external procedures are not yet stable.
-====
+//The `failureReason` entry is deprecated from ...
 
-// Starting from Neo4j 2025.01, a new JSON template is available for the query log, which is the default set in server_log.xml.
+// Starting from Neo4j 2025.01, a new JSON template is available for the query log, which is the default set in _server_log.xml_.
 // It contains the `errorInfo` entry, but not the `failureReason` entry, which is switched off by default.
 
 

modules/ROOT/pages/index.adoc

@@ -9,7 +9,7 @@ endif::[]
 :description: Status codes for errors and notifications Neo4j 5
 :neo4j-buildnumber: {neo4j-version}
 
-This manual provides status codes for errors and notifications that a Neo4j server may return to indicate the result of a Cypher request.
+This manual covers all status codes for errors and notifications that a Neo4j server may return to indicate the result of a Cypher request.
 
 Starting from 5.23 for notifications and 5.25 for errors, the Neo4j DBMS supports the GQL standard. +
 GQL is the new link:https://www.iso.org/home.html[ISO] International Standard query language for graph databases.

modules/ROOT/pages/notifications/index.adoc

@@ -3,43 +3,38 @@
 [[notifications]]
 = Server notifications
 
-After a successful query execution, the Neo4j server sends notifications to provide advice on how to improve the query's quality or give additional information about the query execution.
+After a successful query execution, the Neo4j server sends notifications to give additional information about the query execution or provide advice on how to improve the query's quality.
 The driver receives these notifications and sends them to the Neo4j tools (e.g. Browser, Bloom, Cypher Shell) or the user application, which display them to the user.
 
 From version 5.23, Neo4j has a new GqlStatusObject API in addition to the existing Notification API (deprecated since 5.26).
 The GqlStatusObject API provides information about the status of a Cypher query or command execution in compliance with the link:https://www.iso.org/standard/76120.html[ISO/IEC 39075:2024(en) - Information technology - Database languages - GQL Standard].
 
-This page describes the GQL-status object and the Neo4j notification frameworks, their structure, the objects they provide for notifications, and how to interpret them.
+This page describes the GQL-status object and the Neo4j notification frameworks, their structure, the objects they provide for notification, and how to interpret them.
 It also explains the server notification grouping and filtering, the notification internals, and the server-driver compatibility for both the Notification and GqlStatusObject APIs.
 
 [role=label--version-5.23]
 [[gqlstatus-notification-object]]
 == GQL-status notification object
 
-In the GQL-status object framework, notifications are an implementation-defined subset of the GQL-status objects that cover informational notes and warnings, but not errors, `SUCCESS`, `NO DATA`, or `OMITTED RESULT`.
-For the latter, see <<general-codes-for-success, General codes for success>>. +
-
-In GQL, the execution of a query from user to server always has an outcome, called the _execution outcome_.
-The execution outcome is a list of GQL-status objects, ordered by the following precedence, where the first object in the list is the primary GQL-status object:
+In the GQL-status object framework, when a user executes a query to the server, it always produces a result known as the _execution outcome_.
+If no error occurs during execution, the outcome is recorded as a completion condition, indicating a successful result with a regular non-empty result, an omitted result, or no data.
+It is represented as a list of GQL-status objects, which are organized according to the following precedence rules, where the first object in the list is the primary GQL-status object:
 
 . `NO DATA` has precedence over `WARNING`.
 . `WARNING` has precedence over the `SUCCESSFUL COMPLETION` subclass.
 . `SUCCESSFUL COMPLETION` subclass has precedence over `INFORMATIONAL`.
 . `INFORMATIONAL` is the condition with the least precedence.
 
+For more information about `SUCCESSFUL COMPLETION`, `NO DATA`, or `OMITTED RESULT`, see <<general-codes-for-success, General codes for success>>. +
+The GQL-status object can contain multiple GQL-status objects, where each object represents a different condition of the query execution.
 The primary GQL-status object describes the condition with the greatest precedence and is always present.
 All other GQL-status objects in the list are additional GQL-status objects.
 
-The GQL-status object also includes the Neo4j-specific information, such as the severity level and the classification of the notification, which can be used for filtering.
+The GQL-status object also includes Neo4j-specific information, such as severity level and notification classification, which can be used for filtering.
 For more information about notification grouping and filtering, see <<notification-grouping-and-filtering>>.
 
 Each GQL-status object consists of the following fields:
-— A GQLSTATUS, which is a character string identifying a condition as defined in Subclause 23.1,
-“GQLSTATUS”.
-— A status description, which is a character string describing the GQLSTATUS.
-— A record with diagnostic information as defined in Subclause 23.2, “Diagnostic records”.
-— An optional nested GQL-status object for providing additional diagnostic information, such as a
-cause.
+
 .GQLSTATUS notification object
 [cols="<1s,<4"]
 |===
@@ -50,7 +45,7 @@ a| A human-readable description of the GQLSTATUS, which consists of a condition,
 The condition and subcondition are textual representations of the class and subclass codes, respectively.
 | DiagnosticRecord
 a| Extra information about the status, given as key-value pairs, both on the server and driver side.
-To retrieve the full diagnostic record, you can use the `diagnosticRecord()` method on both the server and driver sides.
+To retrieve the full diagnostic record, you can use the `diagnosticRecord()` on the server side or the corresponding method on the driver sides.
 Additional helper methods are exposed for some useful fields.
 [cols="<1s,<4"]
 !===
@@ -154,21 +149,21 @@ The following table lists the Neo4j-defined groups of GQLSTATUS codes and their
 |===
 
 [role=label--deprecated-5.26]
-[[-notification-object]]
-==  notification object
+[[neo4j-notification-object]]
+== Neo4j-status notification object
 
-The Neo4j  notification object contains diagnostic information representing the successful outcome of a Cypher query or command execution, including severity, the `ClientNotification` code, category, title, description, and position in the query text where the notification is relevant.
+The Neo4j-status object for notifications contains diagnostic information representing the successful outcome of a Cypher query or command execution, including severity, the `ClientNotification` code, category, title, description, and position in the query text where the notification is relevant.
 Depending on the application, some of the fields from the notification object might not be visible.
 
-The  notification object consists of the following fields:
+The notification object consists of the following fields:
 
-.Neo4j  notification object
+.Neo4j notification object
 [cols="<1s,<4"]
 |===
-|Neo4j  code
-a|The Neo4j status code in the form of `Neo.ClientNotification.[SubType].[Name]`.
+|Neo4j code
+a|The Neo4j code in the form of `Neo.ClientNotification.[SubType].[Name]`.
 |Title
-a|The title of the Neo4j status code.
+a|The title of the Neo4j code.
 |Description
 a|The description of the specific notification.
 |Severity level