Skip to content

Commit 12aa4ce

Browse files
renetapopovarenetapopova
committed
Add a GQLSTATUS code to the current errors
1 parent 723874e commit 12aa4ce

File tree

2 files changed

+91
-25
lines changed

2 files changed

+91
-25
lines changed

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

Lines changed: 90 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,109 @@
11
:description: The Neo4j error codes for Neo4j version {neo4j-version}.
22

3-
43
[[neo4j-errors]]
5-
= List of all server error codes
4+
= List of all Neo4j 5 server error codes
5+
6+
Error codes are Neo4j status codes returned by the server when the execution of a query fails.
7+
They always have the severity level `ERROR`.
8+
Errors are grouped based on the type of the error code:
9+
10+
Client errors::
11+
These errors are caused by the client and are usually related to the request itself.
12+
Client errors have the prefix `Neo.ClientError`.
13+
14+
Transient errors::
15+
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.
16+
The error can be temporary and could therefore succeed if retrying the request.
17+
Transient errors have the prefix `Neo.TransientError`.
18+
19+
Database errors::
20+
These errors are caused by the database and are usually related to the database state.
21+
Database errors have the prefix `Neo.DatabaseError`.
622

723
This page contains lists of all Neo4j errors, grouped by type.
824

25+
[[neo4j-client-errors]]
926
== Client errors
1027

1128
This is a complete list of all client errors Neo4j may return, and what they mean.
1229

30+
[[Neo.ClientError.ChangeDataCapture.InvalidIdentifier]]
31+
=== `Neo.ClientError.ChangeDataCapture.InvalidIdentifier`
32+
33+
This error occurs when the given change identifier is invalid.
34+
35+
.Error details
36+
[cols="<1s,<4"]
37+
|===
38+
|Description
39+
a| Invalid change identifier.
40+
|GQLSTATUS code(s)
41+
m|52N16
42+
| Returned message(s)
43+
a|
44+
[options="header", cols="<4,<1"]
45+
!===
46+
! Message ! GQLSTATUS code
47+
! Invalid change identifier. ! 52N26
48+
! Given change identifier does not belong to this database ! 52N31
49+
! Given ChangeIdentifier describes a transaction that hasn't yet occurred ! 52N30
50+
! Unable to find the transaction entry for the given change identifier ! 52N28
51+
!Given ChangeIdentifier describes a transaction that occurred before any enrichment records exist ! 52N29
52+
!===
53+
|===
54+
55+
[[Neo.ClientError.Cluster.NotALeader]]
56+
=== `Neo.ClientError.Cluster.NotALeader`
57+
58+
This error occurs when the request cannot be processed by this server.
59+
Write requests can only be processed by the leader.
60+
61+
.Error details
62+
[cols="<1s,<4"]
63+
|===
64+
|Description
65+
a| The request cannot be processed by this server. Write requests can only be processed by the leader.
66+
|GQLSTATUS code(s)
67+
m|08N07
68+
| Returned message(s)
69+
a|
70+
[options="header", cols="<4,<1"]
71+
!===
72+
! Message ! GQLSTATUS code
73+
! Failed to acquire lease since it was taken by another candidate!08N07
74+
! Local instance lost lease. !08N07
75+
! Should only attempt to acquire lease when leader. !08N07
76+
!===
77+
|===
78+
79+
80+
[[Neo.ClientError.Cluster.Routing]]
81+
=== `Neo.ClientError.Cluster.Routing`
82+
83+
This error occurs when the request cannot be routed to the appropriate server.
84+
85+
.Error details
86+
[cols="<1s,<4"]
87+
|===
88+
|Description
89+
a| Unable to route the request to the appropriate server
90+
|GQLSTATUS code(s)
91+
m|08N02
92+
| Returned message(s)
93+
a|Unable to route to database `$dbName`. Server-side routing is disabled. Either connect to the database directly using the driver (or interactively with the :use command), or enable server-side routing by setting `$routingEnabledSetting=true`.
94+
|===
95+
96+
//================================================================
97+
// Current list of all errors to be used as a reference
98+
1399
[options="header", cols="<1m,<1"]
14100
|===
15101
16102
| Neo4j status code
17103
| Description
18104
19-
| Neo.ClientError.ChangeDataCapture.InvalidIdentifier
20-
| Invalid change identifier.
21-
22-
| Neo.ClientError.Cluster.NotALeader
23-
| The request cannot be processed by this server. Write requests can only be processed by the leader.
24-
25-
| Neo.ClientError.Cluster.Routing
26-
| Unable to route the request to the appropriate server
105+
|
106+
|
27107
28108
| Neo.ClientError.Database.DatabaseNotFound
29109
| The request referred to a database that does not exist.

‎modules/ROOT/pages/errors/index.adoc‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,4 @@
44
= Server errors
55

66
Error codes are Neo4j status codes returned by the server when the execution of a query fails.
7-
They always have the severity level `ERROR`.
8-
Errors are grouped based on the type of the error code:
9-
10-
Client errors::
11-
These errors are caused by the client and are usually related to the request itself.
12-
Client errors have the prefix `Neo.ClientError`.
13-
14-
Transient errors::
15-
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.
16-
The error can be temporary and could therefore succeed if retrying the request.
17-
Transient errors have the prefix `Neo.TransientError`.
18-
19-
Database errors::
20-
These errors are caused by the database and are usually related to the database state.
21-
Database errors have the prefix `Neo.DatabaseError`.
7+
They always have the severity level `ERROR`.

0 commit comments

Comments
 (0)