remove legacy and further updates

Author: renetapopova

README.adoc

@@ -2,7 +2,7 @@
 
 = docs-status-codes
 
-This repository contains the AsciiDoc and other sources to build the link:{docs-uri}/status-codes[Neo4j Status Codes].
+This repository contains the AsciiDoc and other sources to build the link:{docs-uri}/status-codes[Status Codes for Errors & Notifications].
 
 [[local-build]]
 == Installation

antora.yml

@@ -1,5 +1,5 @@
 name: status-codes
-title: Status Codes
+title: Status Codes for Errors & Notifications
 version: '5'
 start_page: ROOT:index.adoc
 nav:

modules/ROOT/pages/changelogs.adoc

@@ -1,6 +1,18 @@
 :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].
+
 == Neo4j 5.24
 
 **New:**

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

@@ -1,19 +1,18 @@
-:description: The legacy error codes for Neo4j 5.
+:description: The error codes for Neo4j 5.
 
 
 [[neo4j-errors]]
-= List of legacy server error codes
+= List of Neo4j codes
 
-This page lists the legacy server error codes, also known as Neo4j status codes.
-These will be replaced by xref:errors/gql-errors.adoc[GQLSTATUS server 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:
 
 Client errors::
-These errors are caused by the client and are usually related to the request itself.
-The Neo4j status codes for client errors have the prefix `Neo.ClientError`.
+These errors are caused by the client (user input or user application) and are usually related to the request itself.
+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.
@@ -33,7 +32,7 @@ This is a complete list of all client errors Neo4j may return, and what they mea
 [options="header", cols="<1m,<1"]
 |===
 
-| Neo4j legacy code
+| Neo4j  code
 | Description
 
 | Neo.ClientError.ChangeDataCapture.InvalidIdentifier
@@ -299,7 +298,7 @@ This is a complete list of all transient errors Neo4j may return, and what they
 [options="header", cols="<1m,<1"]
 |===
 
-| Neo4j legacy code
+| Neo4j  code
 | Description
 
 | Neo.TransientError.ChangeDataCapture.FutureIdentifier
@@ -406,7 +405,7 @@ This is a complete list of all database errors Neo4j may return, and what they m
 [options="header", cols="<1m,<1"]
 |===
 
-| Neo4j legacy code
+| Neo4j  code
 | Description
 
 | Neo.DatabaseError.ChangeDataCapture.Disabled

modules/ROOT/pages/errors/index.adoc

@@ -6,8 +6,14 @@ The Neo4j DBMS returns a server error to indicate that the outcome of a Cypher q
 
 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].
 
+[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].
+====
+
 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 legacy errors.
+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]]
@@ -57,7 +63,7 @@ This wrapped object is referred to as a `cause` and used to provide additional,
 [[gqlstatus-neo4j-defined-codes]]
 == Classes of GQLSTATUS error codes
 
-The Neo4j GQLSTATUS codes are divided into classes and subclasses.
+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.
@@ -88,19 +94,19 @@ The following table lists the GQLSTATUS classes and their meanings:
 | procedure exception
 |===
 
-[[legacy-error-object]]
-== Legacy error object
+[[-error-object]]
+== Neo4j error object
 
-The Neo4j legacy 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  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.
 Depending on the application, some of the fields from the error object might not be visible.
 
 The error object consists of the following fields:
 
-.Neo4j legacy error object
+.Neo4j error object
 [cols="<1s,<4"]
 |===
-|Neo4j legacy code
-a|The Neo4j status code in the form of `Neo.[Type].[SubType].[Name]`.
+|Neo4j code
+a|The Neo4j code in the form of `Neo.[Type].[SubType].[Name]`.
 |Description
 a|The description of the specific error.
 |Message
@@ -114,38 +120,38 @@ Available categories are `CLIENT_ERROR`, `TRANSIENT_ERROR`, and `DATABASE_ERROR`
 a|(Optional) The position, given by offset, line and column, where the error is relevant in the query text.
 |===
 
-For more information, see the xref:errors/all-errors.adoc[List of legacy server error codes].
+For more information, see the xref:errors/all-errors.adoc[List of Neo4j error codes].
 
-[[error-grouping-and-filtering]]
-== Server error classification
+[[error-types]]
+== Types of server errors
 
 The fact that an error is returned by the server does not always mean that it is a fatal error.
 Status codes can also indicate transient problems that may go away if you retry the request.
-The server error classification determines the effect on the transaction.
+The server error group determines the effect on the transaction.
 
-.Server error classification
+.Server error types
 [options="header", cols="<1m,<2,<1"]
 |===
 
-| Classification
+| Type
 | Description
 | Effect on the transaction
 
-| xref:errors/all-errors.adoc#_client_errors[ClientError]
-| These errors are caused by the client and are usually related to the request itself.
+| ClientError
+| These errors are caused by the client (user input or user application) and are usually related to the request itself.
 Changing the request might yield a successful outcome.
-Legacy client errors have the prefix `Neo.ClientError`.
+ Neo4j codes have the prefix `Neo.ClientError`, while the GQLSTATUS codes have `ErrorClassification` of type `CLIENT_ERROR`.
 | Rollback
 
-| xref:errors/all-errors#_transient_errors[TransientError]
+| TransientError
 | 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, therefore retrying later might yield a successful outcome.
-Legacy transient errors have the prefix Neo.`TransientError`.
+Neo4j codes have the prefix Neo.`TransientError`, while the GQLSTATUS codes have `ErrorClassification` of type `TRANSIENT_ERROR`.
 | Rollback
 
-| xref:errors/all-errors#_database_error[DatabaseError]
+| DatabaseError
 | These errors are caused by the database and are usually related to the database state and mean that the database failed to service the request.
-Legacy database errors have the prefix `Neo.DatabaseError`.
+Neo4j codes have the prefix `Neo.DatabaseError`, while the GQLSTATUS codes have `ErrorClassification` of type `DATABASE_ERROR`.
 | Rollback
 
 |===
@@ -154,14 +160,14 @@ Legacy database errors have the prefix `Neo.DatabaseError`.
 == Error internals
 
 Neo4j supports server errors in the form of Java exceptions.
-Most of these implement the `HasStatus` interface, which means they have a Neo4j status code in addition to the exception message.
+Most of these implement the `HasStatus` interface, which means they have a status code in addition to the exception message.
 
-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 Neo4j status code.
+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 cause field is a wrapped underlying Neo4j exception, which 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 status code.
+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.
 Exactly how this looks, depends on the combination of driver and server versions.
 See <<server-driver-compatibility, Server-driver version compatibility>> for more information.

modules/ROOT/pages/index.adoc

@@ -1,15 +1,15 @@
 
 [[status-codes]]
 ifdef::backend-pdf[]
-= Neo4j 5 Status Codes
+= Status Codes for Errors and Notifications
 endif::[]
 ifndef::backend-pdf[]
 = Introduction
 endif::[]
-:description: The Neo4j status codes for Neo4j version {neo4j-version}.
+:description: Status codes for errors and notifications Neo4j 5
 :neo4j-buildnumber: {neo4j-version}
 
-The Neo4j 5 Status Codes manual includes all status codes that a Neo4j server may return to indicate the outcome of a Cypher request.
+This manual provides 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.
@@ -19,8 +19,6 @@ For more information, see link:https:https://neo4j.com/docs/cypher-manual/curren
 As part of this GQL compliance, Cypher now also includes status codes that a GQL-compliant DBMS returns to indicate the outcome of a request.
 For more information on the GQL-status object framework for notifications and errors, see xref:notifications/index.adoc[] and xref:errors/index.adoc[].
 
-This manual details all status codes that a Neo4j DBMS may return, including both GQL-compliant and legacy Neo4j status codes.
-
 ifndef::backend-pdf[]
 License: link:{common-license-page-uri}[Creative Commons 4.0]
 endif::[]