Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
cc5f8c0
Error missing in the content-nav (#294)
lidiazuin Apr 10, 2025
16559ba
Fix a wrong title for 52N28 (#296)
renetapopova Apr 10, 2025
ba5cc44
Add errors implemented in 2025.04 (#299)
NataliaIvakina Apr 28, 2025
f42d50b
Add errors implemented in the code (#304)
NataliaIvakina Apr 30, 2025
6015f84
Update version to 2025.05 (#306)
renetapopova Apr 30, 2025
41a47ad
Change parameter of 42N11 to a list. (#300)
Lojjs May 1, 2025
93f19db
Final surface codes (#301)
JoelBergstrand May 1, 2025
dc6b4b3
Generate gql-errors index.adoc file (#302)
renetapopova May 6, 2025
51b4a9e
Update the scripts readme (#310)
renetapopova May 6, 2025
240409c
Document new GQLSTATUS 22NB9 (#303)
Lojjs May 8, 2025
1abaa32
Fix a heading mistake and the index generation message (#314)
renetapopova May 9, 2025
8d6c26d
Add some missing glossary entries and fix 42I14 (#317)
renetapopova May 19, 2025
0cf19ec
Update the readme file (#318)
renetapopova May 19, 2025
e68d6af
Add a note that error messages are deprecated (#313)
renetapopova May 19, 2025
055a4cc
"or an application-generated id" -> "or consider using an application…
hvub May 27, 2025
d5829c6
Add 52N40 and 52N41 (#321)
nick-giles-neo May 27, 2025
05e5ecc
Update version to 2025.06 (#337)
renetapopova Jun 3, 2025
e869062
Remove old Neo4j statuses. (#291)
Lojjs Jun 5, 2025
e181f58
Update 51N31 to not use <<item>> (#328)
Hunterness Jun 5, 2025
3b19ee9
Add new GQLSTATUS 22NBA (#329)
Lojjs Jun 5, 2025
6aca200
Fix error message so it makes sense (#335)
ConorNeo Jun 5, 2025
44320be
Extend 51N41 with reason (#342)
gfx54b Jun 16, 2025
bc5ce3c
Add 22NBC (#343)
sherfert Jun 16, 2025
984cb3f
Clarify that 42NA8 might show sub-commands (#348)
Lojjs Jun 30, 2025
e6d56a2
Merge branch 'dev' into cypher-25-merge-dev
renetapopova Jul 2, 2025
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
8 changes: 4 additions & 4 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: status-codes
title: Status Codes for Errors & Notifications
version: '2025.05'
version: '2025.06'
start_page: ROOT:index.adoc
nav:
- modules/ROOT/content-nav.adoc
asciidoc:
attributes:
page-origin-private: false
neo4j-version: '2025.05'
neo4j-version-exact: '2025.05.0'
neo4j-buildnumber: '2025.05'
neo4j-version: '2025.06'
neo4j-version-exact: '2025.06.0'
neo4j-buildnumber: '2025.06'
2 changes: 2 additions & 0 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@
**** xref:errors/gql-errors/22NB7.adoc[]
**** xref:errors/gql-errors/22NB8.adoc[]
**** xref:errors/gql-errors/22NB9.adoc[]
**** xref:errors/gql-errors/22NBA.adoc[]
**** xref:errors/gql-errors/22NBC.adoc[]
*** xref:errors/gql-errors/index.adoc#invalid-transaction-state[Invalid transaction state]
**** xref:errors/gql-errors/25G02.adoc[]
**** xref:errors/gql-errors/25N01.adoc[]
Expand Down
6 changes: 0 additions & 6 deletions modules/ROOT/pages/errors/all-errors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,6 @@ This is a complete list of all client errors Neo4j may return, and what they mea
An illegal chain of aliases has been detected.
This request cannot be executed.

| Neo.ClientError.Fabric.AccessMode
| The request could not be completed due to an access mode violation

| Neo.ClientError.General.ForbiddenOnReadOnlyDatabase
| This is a read-only database, writing or modifying the database is not allowed.

Expand Down Expand Up @@ -421,9 +418,6 @@ This is a complete list of all database errors Neo4j may return, and what they m
| Neo.DatabaseError.Database.Unknown
| Unknown database management error.

| Neo.DatabaseError.Fabric.RemoteExecutionFailed
| The database was unable to execute a remote part of the statement.

| Neo.DatabaseError.General.IndexCorruptionDetected
|
The request (directly or indirectly) referred to an index that is in a failed state.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/errors/gql-errors/08N19.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= 08N19

== Status description
error: connection exception - shard execution transient error. Communication with shard `{ <<graph>> }` failed. with message `{ <<msg>> }`.
error: connection exception - shard execution transient error. Communication with shard `{ <<graph>> }` failed with message `{ <<msg>> }`.


ifndef::backend-pdf[]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/errors/gql-errors/08N20.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= 08N20

== Status description
error: connection exception - shard execution database error. Communication with shard `{ <<graph>> }` failed. with message `{ <<msg>> }`.
error: connection exception - shard execution database error. Communication with shard `{ <<graph>> }` failed with message `{ <<msg>> }`.


ifndef::backend-pdf[]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/errors/gql-errors/08N21.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= 08N21

== Status description
error: connection exception - shard execution client error. Communication with shard `{ <<graph>> }` failed. with message `{ <<msg>> }`.
error: connection exception - shard execution client error. Communication with shard `{ <<graph>> }` failed with message `{ <<msg>> }`.


ifndef::backend-pdf[]
Expand Down
27 changes: 27 additions & 0 deletions modules/ROOT/pages/errors/gql-errors/22NBA.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
= 22NBA

== Status description

error: data exception - omitting mandatory field for property type constraints for vectors. Property type constraints for vectors need to define both coordinate type and dimension.

== Example scenario

For example, try to create a property type constraint for a vector, omitting the dimension:

[source,cypher]
----
CREATE CONSTRAINT myConstraint
FOR (n:Label)
REQUIRE n.prop IS :: VECTOR<INTEGER>
----

You will receive an error with GQLSTATUS xref:errors/gql-errors/50N11.adoc[50N11].
This error has a cause detailed in xref:errors/gql-errors/22N90.adoc[22N90], which also has a subsequent cause with GQLSTATUS 22NBA and the status description above.


ifndef::backend-pdf[]
[discrete.glossary]
== Glossary

include::partial$glossary.adoc[]
endif::[]
21 changes: 21 additions & 0 deletions modules/ROOT/pages/errors/gql-errors/22NBC.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
= 22NBC

== Status description

error: data exception - index belongs to constraint. Index belongs to constraint `{ <<constrDescrOrName>> }`.

== Scenario

This error code is used when the user tries drop an index belonging to a constraint.

== Possible solution

Drop the constraint instead.


ifndef::backend-pdf[]
[discrete.glossary]
== Glossary

include::partial$glossary.adoc[]
endif::[]
32 changes: 32 additions & 0 deletions modules/ROOT/pages/errors/gql-errors/42NA8.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,38 @@
== Status description
error: syntax error or access rule violation - invalid reference in command. Invalid reference in command `{ <<cmd>> }`.

== Explanation

This error occurs as the cause of other exceptions, for example, when you try to:

* Grant or deny privileges to, or revoke privileges from, a role that does not exist.
* Grant or deny privileges to, or revoke privileges from, a role to perform administration commands on a database that does not exist.
* Revoke a role from a user in Cypher 25, where either the role or the user does not exist.
In Cypher 5, this last example gives a notification instead, see xref:notifications/all-notifications.adoc#_neo_clientnotification_security_impossiblerevokecommand[Impossible revoke command].

== Example scenario

For example, given that `role1` exists but `role2` does not, try to grant a privilege to both roles:

[source,cypher]
----
GRANT WRITE ON GRAPH * TO role1, role2
----

[source]
----
error: syntax error or access rule violation - invalid reference in command. Invalid reference in command `GRANT WRITE ON GRAPH * NODES * TO role2`.
----

The command returns an error with GQLSTATUS xref:errors/gql-errors/42001.adoc[42001] and a cause with this GQLSTATUS 42NA8 and the status description above.
The cause has a subsequent cause with GQLSTATUS xref:errors/gql-errors/42N10.adoc[42N10].

[NOTE]
====
The command in the status description might not be the exact command you typed.
Internally, the Neo4j administration commands are separated into more specific sub-commands, and the Cypher shown corresponds to the sub-command that was executed when the error occurred.
====

ifndef::backend-pdf[]
[discrete.glossary]
== Glossary
Expand Down
4 changes: 3 additions & 1 deletion modules/ROOT/pages/errors/gql-errors/51N31.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
:page-role: changed-2025.06

= 51N31

== Status description

error: system configuration or operation exception - not supported. `{ <<item>> }` is not supported in `{ <<context>> }`.
error: system configuration or operation exception - not supported. `{ <<feat>> }` is not supported in `{ <<context>> }`.


ifndef::backend-pdf[]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/errors/gql-errors/51N41.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= 51N41

== Status description
error: system configuration or operation exception - admin operation failed. Server or database admin operation not possible.
error: system configuration or operation exception - admin operation failed. Server or database admin operation not possible. Reason: `{ <<msg>> }`

ifndef::backend-pdf[]
[discrete.glossary]
Expand Down
31 changes: 26 additions & 5 deletions modules/ROOT/pages/errors/gql-errors/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,15 +106,15 @@ Status description:: error: connection exception - general driver database error

=== xref:errors/gql-errors/08N19.adoc[08N19]

Status description:: error: connection exception - shard execution transient error. Communication with shard `{ <<graph>> }` failed. with message `{ <<msg>> }`.
Status description:: error: connection exception - shard execution transient error. Communication with shard `{ <<graph>> }` failed with message `{ <<msg>> }`.

=== xref:errors/gql-errors/08N20.adoc[08N20]

Status description:: error: connection exception - shard execution database error. Communication with shard `{ <<graph>> }` failed. with message `{ <<msg>> }`.
Status description:: error: connection exception - shard execution database error. Communication with shard `{ <<graph>> }` failed with message `{ <<msg>> }`.

=== xref:errors/gql-errors/08N21.adoc[08N21]

Status description:: error: connection exception - shard execution client error. Communication with shard `{ <<graph>> }` failed. with message `{ <<msg>> }`.
Status description:: error: connection exception - shard execution client error. Communication with shard `{ <<graph>> }` failed with message `{ <<msg>> }`.


[[data-exceptions]]
Expand Down Expand Up @@ -611,6 +611,14 @@ Status description:: error: data exception - invalid Neo4j type. `{ <<input>> }`

Status description:: error: data exception - invalid inner list type. Lists cannot have `{ <<typeDescription>> }` as an inner type in this context.

=== xref:errors/gql-errors/22NBA.adoc[22NBA]

Status description:: error: data exception - omitting mandatory field for property type constraints for vectors. Property type constraints for vectors need to define both coordinate type and dimension.

=== xref:errors/gql-errors/22NBC.adoc[22NBC]

Status description:: error: data exception - index belongs to constraint. Index belongs to constraint `{ <<constrDescrOrName>> }`.


[[invalid-transaction-state]]
== Invalid transaction state
Expand Down Expand Up @@ -1194,6 +1202,18 @@ Status description:: error: syntax error or access rule violation - incompatible

Status description:: error: syntax error or access rule violation - invalid use of `CALL { ... }`. Not possible to enclose `{ <<clause>> }` in `CALL { ... }`. Use `CALL () { ... }` instead.

=== xref:errors/gql-errors/42N3A.adoc[42N3A]

Status description:: error: syntax error or access rule violation - incompatible conditional query. All `{ <<context>> }` need to either return rows or update the graph.

=== xref:errors/gql-errors/42N3B.adoc[42N3B]

Status description:: error: syntax error or access rule violation - incompatible number of return columns. All `{ <<context>> }` must return the same number of columns.

=== xref:errors/gql-errors/42N3C.adoc[42N3C]

Status description:: error: syntax error or access rule violation - invalid use of `CALL { ... }`. Not possible to enclose `{ <<clause>> }` in `CALL { ... }`. Use `CALL () { ... }` instead.

=== xref:errors/gql-errors/42N40.adoc[42N40]

Status description:: error: syntax error or access rule violation - single relationship pattern required. The `{ <<fun>> }` function must contain one relationship pattern.
Expand Down Expand Up @@ -1661,9 +1681,10 @@ Status description:: error: system configuration or operation exception - not su

Status description:: error: system configuration or operation exception - not supported with this configuration. `{ <<item>> }` is not supported in `{ <<context>> }`.

[role=label--changed-2025.06]
=== xref:errors/gql-errors/51N31.adoc[51N31]

Status description:: error: system configuration or operation exception - not supported. `{ <<item>> }` is not supported in `{ <<context>> }`.
Status description:: error: system configuration or operation exception - not supported. `{ <<feat>> }` is not supported in `{ <<context>> }`.

=== xref:errors/gql-errors/51N32.adoc[51N32]

Expand Down Expand Up @@ -1703,7 +1724,7 @@ Status description:: error: system configuration or operation exception - unable

=== xref:errors/gql-errors/51N41.adoc[51N41]

Status description:: error: system configuration or operation exception - admin operation failed. Server or database admin operation not possible.
Status description:: error: system configuration or operation exception - admin operation failed. Server or database admin operation not possible. Reason: `{ <<msg>> }`

=== xref:errors/gql-errors/51N43.adoc[51N43]

Expand Down
130 changes: 0 additions & 130 deletions modules/ROOT/pages/notifications/all-notifications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1218,136 +1218,6 @@ The query contains an aggregation function that skips null values.
======
=====

[#_unsupported_notifications]
== `UNSUPPORTED` notifications

Unsupported notifications are returned when the query or command is trying to use features that are not supported by the current system or using experimental features that should not be used in production.

[#_neo_clientnotification_statement_runtimeunsupportedwarning]
=== Unsupported runtime

.Notification details
[cols="<1s,<4"]
|===
|Neo4j code
m|Neo.ClientNotification.Statement.RuntimeUnsupportedWarning
|Title
a|This query is not supported by the chosen runtime.
|Description
|Selected runtime is unsupported for this query, please use a different runtime instead or fallback to default.
(`%s`)
|Category
m|UNSUPPORTED
|GQLSTATUS code
m|01N40
|Status description
a|warn: unsupported runtime.
The query cannot be executed with `{ <<preparserInput>>1 }`, `{ <<preparserInput>>2 }` is used.
Cause: `{ <<msg>> }`.
|Classification
m|UNSUPPORTED
|SeverityLevel
m|WARNING
|===

.A runtime is not supported by a Cypher command
[.tabbed-example]
=====
[.include-with-GQLSTATUS-code]
======
Query::
+
[source,cypher]
----
EXPLAIN CYPHER runtime=pipelined SHOW INDEXES YIELD *
----

Returned GQLSTATUS code::
01N40

Returned status description::
warn: unsupported runtime.
The query cannot be executed with `runtime=pipelined`, `runtime=slotted` is used.
Cause: Pipelined does not yet support the plans including `ShowIndexes`, use another runtime.

Suggestions for improvement::
Use a different runtime or remove the runtime option to run the query with the default runtime:
+
[source,cypher]
----
SHOW INDEXES YIELD *
----
======
[.include-with-neo4j-code]
======

Query::
+
[source,cypher]
----
CYPHER runtime=pipelined SHOW INDEXES YIELD *
----

Description of the returned code::
Selected runtime is unsupported for this query, please use a different runtime instead or fallback to default.
(Pipelined does not yet support the plans including `ShowIndexes`, use another runtime.)

Suggestions for improvement::
Use a different runtime or remove the runtime option to run the query with the default runtime:
+
[source,cypher]
----
SHOW INDEXES YIELD *
----

======
=====

[role=label--deprecated-5.14]
[#_neo_clientnotification_statement_runtimeexperimental]
=== RuntimeExperimental

[NOTE]
====
The usage of this notification has been removed since Neo4j 5.14.
====

.Notification details
[cols="<1s,<4"]
|===
|Neo4j code
m|Neo.ClientNotification.Statement.RuntimeExperimental
|Title
a|This feature is experimental and should not be used in production systems.
|Description
|You are using an experimental feature (`%s`)
|Category
m|UNSUPPORTED
|SeverityLevel
m|WARNING
|===

.Use of the parallel runtime
====
Query::
+
[source,cypher]
----
CYPHER runtime=parallel MATCH (n) RETURN (n)
----

Description of the returned code::
You are using an experimental feature (The parallel runtime is experimental and might suffer from instability and potentially correctness issues.)

Suggestions for improvement::
The parallel runtime should not be used in production. Choose another runtime or remove the option to use the default runtime:
+
[source,cypher]
----
MATCH (n) RETURN (n)
----
====

[#_deprecated_notifications]
== `DEPRECATION` notifications

Expand Down