Skip to content

Commit d7ac33b

Browse files
renetapopovaLojjs
andauthored
Apply feedback from review (#230)
Co-authored-by: Louise Söderström <[email protected]>
1 parent 6571d3a commit d7ac33b

File tree

4 files changed

+17
-36
lines changed

4 files changed

+17
-36
lines changed

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

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,7 @@
44
[[neo4j-errors]]
55
= List of Neo4j error codes
66

7-
This page lists the current Neo4j error codes, which which are returned along side xref:errors/gql-errors.adoc[GQLSTATUS error codes].
8-
9-
Error codes are returned by the server when the execution of a query fails.
10-
They always have the severity level `ERROR`.
11-
Errors are grouped based on the type of the Neo4j code:
12-
13-
Client errors::
14-
These errors are caused by the client (user input or user application) and are usually related to the request itself.
15-
The Neo4j codes for client errors have the prefix `Neo.ClientError`.
16-
17-
Transient errors::
18-
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.
19-
The error can be temporary, and the request could succeed if retried.
20-
The Neo4j codes for transient errors have the prefix `Neo.TransientError`.
21-
22-
Database errors::
23-
These errors are caused by the database and are usually related to the database state.
24-
The Neo4j codes for database errors have the prefix `Neo.DatabaseError`.
25-
26-
This page contains lists of all Neo4j errors, grouped by type.
7+
This page lists the current Neo4j error codes, which which are returned along side xref:errors/gql-errors.adoc[GQLSTATUS error codes], grouped by type.
278

289
== Client errors
2910

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ All errors in Neo4j have severity level `ERROR`.
99

1010
[WARNING]
1111
====
12-
Please note that while GQLSTATUS codes remain stable, the status descriptions associated with these codes may change over time.
12+
Please note that while GQLSTATUS codes remain stable (any changes to them will be breaking), changes to status descriptions associated with these codes are not breaking and may happen at any time.
1313
For this reason, parsing the status descriptions or incorporating them into scripts is not recommended.
1414
====
1515

modules/ROOT/pages/errors/index.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
= Server errors
44

55
Neo4j returns a server error to indicate that the outcome of a Cypher query or command execution is unsuccessful.
6-
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.
6+
The driver receives these errors and sends them to the Neo4j tools (e.g. Browser, Bloom, Cypher Shell) or the user application, which display them to the user.
77

88
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].
99
This additional GQL-status object is also displayed in the query log from Neo4j 5.25 onwards.
@@ -44,8 +44,8 @@ Each GQL-status object consists of the following fields:
4444
a| A 5-character string that is the concatenation of a 2-character class code followed by a 3-character subclass code, which identifies the condition of the error.
4545
|StatusDescription
4646
a| A human-readable description of the GQLSTATUS, which consists of a condition, a subcondition, and an optional additional text about the condition.
47-
The condition and subcondition are textual representations of the class and subclass codes, respectively.
4847
The format is `error: condition - subcondition. AdditionalInfo`.
48+
The condition and subcondition are textual representations of the class and subclass codes, respectively.
4949
The subcondition for the subclass 000 is empty.
5050
| DiagnosticRecord
5151
a| Extra information about the status, given as key-value pairs, both on the server and driver side.
@@ -225,30 +225,30 @@ h| Driver 5.25 or older
225225
h| Driver 5.26 or newer
226226

227227
h| Server 5.24 or older
228-
| Bolt: old format
228+
| Bolt: existing error information
229229

230-
Query log: old format
230+
Query log: existing error information
231231

232-
| Bolt: new format with default values
232+
| Bolt: additional GQL-status object with default values
233233

234-
Query log: old format
234+
Query log: existing error information
235235

236236
h| Server 5.25
237-
| Bolt: old format
237+
| Bolt: existing error information
238238

239-
Query log: new format
240-
| Bolt: new format with default values
239+
Query log: additional errorInfo entry
240+
| Bolt: additional GQL-status object with default values
241241

242-
Query log: new format
242+
Query log: additional errorInfo entry
243243

244244
h| Server 5.26 or newer
245-
| Bolt: old format
245+
| Bolt: existing error information
246246

247-
Query log: new format
247+
Query log: additional errorInfo entry
248248

249-
| Bolt: new format
249+
| Bolt: additional GQL-status object
250250

251-
Query log: new format
251+
Query log: additional errorInfo entry
252252

253253
|===
254254

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The following page provides an overview of all notifications in Neo4j, including
1717

1818
[WARNING]
1919
====
20-
Please note that while GQLSTATUS codes remain stable, the status descriptions associated with these codes may change over time.
20+
Please note that while GQLSTATUS codes remain stable (any changes to them will be breaking), changes to status descriptions associated with these codes are not breaking and may happen at any time.
2121
For this reason, parsing the status descriptions or incorporating them into scripts is not recommended.
2222
====
2323

0 commit comments

Comments
 (0)