Skip to content

Commit

Permalink
Add GQL-framework
Browse files Browse the repository at this point in the history
  • Loading branch information
renetapopova committed Nov 29, 2024
2 parents 0076963 + 2b83650 commit 4c9fd33
Show file tree
Hide file tree
Showing 12 changed files with 2,550 additions and 876 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs-pr-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
- "dev"
- "5.x"
- "4.[0-9]"
- "gqlstatus-errors"

jobs:

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/docs-teardown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
- "dev"
- "5.x"
- "4.[0-9]"
- "gqlstatus-errors"
types:
- closed

Expand Down
2 changes: 1 addition & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion antora.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: status-codes
title: Status Codes
title: Status Codes for Errors & Notifications
version: '5'
start_page: ROOT:index.adoc
nav:
Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
* xref:index.adoc[]
* xref:errors/index.adoc[]
** xref:errors/gql-errors.adoc[]
** xref:errors/all-errors.adoc[]
* xref:notifications/index.adoc[]
** xref:notifications/all-notifications.adoc[]
Expand Down
5 changes: 5 additions & 0 deletions modules/ROOT/pages/changelogs.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
:description: This page lists all changes to status codes per Neo4j version.
= Changes to status codes per Neo4j version

== Neo4j 5.25

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:**
Expand Down
29 changes: 24 additions & 5 deletions modules/ROOT/pages/errors/all-errors.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
:description: The Neo4j error codes for Neo4j version {neo4j-version}.
:description: The error codes for Neo4j 5.


[[neo4j-errors]]
= List of all server error codes
= List of Neo4j error codes

This page lists the current Neo4j error codes, which which are returned along side xref:errors/gql-errors.adoc[GQLSTATUS error codes].

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 code:

Client errors::
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.
The error can be temporary, and the request could succeed if retried.
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 codes for database errors have the prefix `Neo.DatabaseError`.

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

Expand All @@ -13,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 status code
| Neo4j code
| Description

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

| Neo4j status code
| Neo4j code
| Description

| Neo.TransientError.ChangeDataCapture.FutureIdentifier
Expand Down Expand Up @@ -386,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 status code
| Neo4j code
| Description

| Neo.DatabaseError.ChangeDataCapture.Disabled
Expand Down
Loading

0 comments on commit 4c9fd33

Please sign in to comment.