Skip to content

Commit 4c9fd33

Browse files
committed
Add GQL-framework
2 parents 0076963 + 2b83650 commit 4c9fd33

File tree

12 files changed

+2550
-876
lines changed

12 files changed

+2550
-876
lines changed

.github/workflows/docs-pr-checks.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77
- "dev"
88
- "5.x"
99
- "4.[0-9]"
10+
- "gqlstatus-errors"
1011

1112
jobs:
1213

.github/workflows/docs-teardown.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77
- "dev"
88
- "5.x"
99
- "4.[0-9]"
10+
- "gqlstatus-errors"
1011
types:
1112
- closed
1213

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
= docs-status-codes
44

5-
This repository contains the AsciiDoc and other sources to build the link:{docs-uri}/status-codes[Neo4j Status Codes].
5+
This repository contains the AsciiDoc and other sources to build the link:{docs-uri}/status-codes[Status Codes for Errors & Notifications].
66

77
[[local-build]]
88
== Installation

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: status-codes
2-
title: Status Codes
2+
title: Status Codes for Errors & Notifications
33
version: '5'
44
start_page: ROOT:index.adoc
55
nav:

modules/ROOT/content-nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
* xref:index.adoc[]
22
* xref:errors/index.adoc[]
3+
** xref:errors/gql-errors.adoc[]
34
** xref:errors/all-errors.adoc[]
45
* xref:notifications/index.adoc[]
56
** xref:notifications/all-notifications.adoc[]

modules/ROOT/pages/changelogs.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
:description: This page lists all changes to status codes per Neo4j version.
22
= Changes to status codes per Neo4j version
33

4+
== Neo4j 5.25
5+
6+
Starting from 5.25, the query log includes the GQL error information under the JSON object `errorInfo`.
7+
For more information, see link:https://neo4j.com/docs/operations-manual/current/monitoring/logging/#gql-error-information[Operations Manual -> GQL error information].
8+
49
== Neo4j 5.24
510

611
**New:**

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

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
1-
:description: The Neo4j error codes for Neo4j version {neo4j-version}.
1+
:description: The error codes for Neo4j 5.
22

33

44
[[neo4j-errors]]
5-
= List of all server error codes
5+
= List of Neo4j error codes
6+
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`.
625

726
This page contains lists of all Neo4j errors, grouped by type.
827

@@ -13,7 +32,7 @@ This is a complete list of all client errors Neo4j may return, and what they mea
1332
[options="header", cols="<1m,<1"]
1433
|===
1534

16-
| Neo4j status code
35+
| Neo4j code
1736
| Description
1837

1938
| Neo.ClientError.ChangeDataCapture.InvalidIdentifier
@@ -279,7 +298,7 @@ This is a complete list of all transient errors Neo4j may return, and what they
279298
[options="header", cols="<1m,<1"]
280299
|===
281300

282-
| Neo4j status code
301+
| Neo4j code
283302
| Description
284303

285304
| Neo.TransientError.ChangeDataCapture.FutureIdentifier
@@ -386,7 +405,7 @@ This is a complete list of all database errors Neo4j may return, and what they m
386405
[options="header", cols="<1m,<1"]
387406
|===
388407

389-
| Neo4j status code
408+
| Neo4j code
390409
| Description
391410

392411
| Neo.DatabaseError.ChangeDataCapture.Disabled

0 commit comments

Comments
 (0)