Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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]"
- "gql-notifications"

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]"
- "gql-notifications"
types:
- closed

Expand Down
6 changes: 3 additions & 3 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ nav:
asciidoc:
attributes:
page-origin-private: false
neo4j-version: '5.22'
neo4j-version-exact: '5.22.0'
neo4j-buildnumber: '5.22'
neo4j-version: '5.23'
neo4j-version-exact: '5.23.0'
neo4j-buildnumber: '5.23'
10 changes: 5 additions & 5 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
* xref:index.adoc[]
** xref:errors/index.adoc[]
*** xref:errors/all-errors.adoc[]
** xref:notifications/index.adoc[]
*** xref:notifications/all-notifications.adoc[]
** xref:changelogs.adoc[]
* xref:errors/index.adoc[]
** xref:errors/all-errors.adoc[]
* xref:notifications/index.adoc[]
** xref:notifications/all-notifications.adoc[]
* xref:changelogs.adoc[]


8 changes: 8 additions & 0 deletions modules/ROOT/pages/changelogs.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
:description: This page lists all changes to status codes per Neo4j version.
= Changes to status codes per Neo4j version

== Neo4j 5.23

From version 5.23, Neo4j has a new GqlStatusObject API in addition to the existing Notification API.

The GqlStatusObject API provides information about the status of a Cypher query or command execution in compliance with the GQL standard.
It includes GQLSTATUS code, StatusDescription, and DiagnosticRecord.
For more information, see xref:notifications/index.adoc#gqlstatus-notification-object[GQL-status notification object].

== Neo4j 5.17

**New:**
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/errors/all-errors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


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

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

Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/errors/index.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:description: The Neo4j error codes for Neo4j version {neo4j-version}.

[[notifications]]
= Error codes
[[error-codes]]
= Server errors

Error codes are Neo4j status codes returned by the server when the execution of a query fails.
They always have the severity level `ERROR`.
Expand Down
21 changes: 19 additions & 2 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@

[[status-codes]]
ifdef::backend-pdf[]
= Neo4j 5 Status Codes
endif::[]
ifndef::backend-pdf[]
= Introduction
endif::[]
:description: The Neo4j status codes for Neo4j version {neo4j-version}.
:neo4j-buildnumber: {neo4j-version}
[[status-codes]]
= Neo4j Status Codes v5


This document details all status codes that a Neo4j DBMS may return to indicate the outcome of a request.


== Format

Each Neo4j status code follows the same format:
Expand All @@ -14,6 +22,7 @@ Each Neo4j status code follows the same format:
Neo.[Type].[SubType].[Name]
-----


== Types of Neo4j status codes

The fact that a Neo4j status code is returned by the server does not always mean there is a fatal error.
Expand Down Expand Up @@ -46,6 +55,14 @@ The type of the status code determines the effect on the transaction.

|===

[NOTE]
====
From version 5.23, Neo4j has a new GqlStatusObject API in addition to the existing Notification API.

The GqlStatusObject API provides information about the status of a Cypher query or command execution in compliance with the GQL standard.
It includes GQLSTATUS code, StatusDescription, and DiagnosticRecord.
For more information, see xref:notifications/index.adoc#gqlstatus-notification-object[GQL-status notification object].
====

ifndef::backend-pdf[]
License: link:{common-license-page-uri}[Creative Commons 4.0]
Expand Down
Loading