diff --git a/antora.yml b/antora.yml index 84b43e4c..eec141cf 100644 --- a/antora.yml +++ b/antora.yml @@ -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' \ No newline at end of file + neo4j-version: '2025.06' + neo4j-version-exact: '2025.06.0' + neo4j-buildnumber: '2025.06' diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index c2213cdb..60977477 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -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[] diff --git a/modules/ROOT/pages/errors/all-errors.adoc b/modules/ROOT/pages/errors/all-errors.adoc index 32e93087..05fee878 100644 --- a/modules/ROOT/pages/errors/all-errors.adoc +++ b/modules/ROOT/pages/errors/all-errors.adoc @@ -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. @@ -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. diff --git a/modules/ROOT/pages/errors/gql-errors/08N19.adoc b/modules/ROOT/pages/errors/gql-errors/08N19.adoc index 01836a70..9df37cb9 100644 --- a/modules/ROOT/pages/errors/gql-errors/08N19.adoc +++ b/modules/ROOT/pages/errors/gql-errors/08N19.adoc @@ -1,7 +1,7 @@ = 08N19 == Status description -error: connection exception - shard execution transient error. Communication with shard `{ <> }` failed. with message `{ <> }`. +error: connection exception - shard execution transient error. Communication with shard `{ <> }` failed with message `{ <> }`. ifndef::backend-pdf[] diff --git a/modules/ROOT/pages/errors/gql-errors/08N20.adoc b/modules/ROOT/pages/errors/gql-errors/08N20.adoc index 6c49f46b..cdcaa4d4 100644 --- a/modules/ROOT/pages/errors/gql-errors/08N20.adoc +++ b/modules/ROOT/pages/errors/gql-errors/08N20.adoc @@ -1,7 +1,7 @@ = 08N20 == Status description -error: connection exception - shard execution database error. Communication with shard `{ <> }` failed. with message `{ <> }`. +error: connection exception - shard execution database error. Communication with shard `{ <> }` failed with message `{ <> }`. ifndef::backend-pdf[] diff --git a/modules/ROOT/pages/errors/gql-errors/08N21.adoc b/modules/ROOT/pages/errors/gql-errors/08N21.adoc index ec61d507..cc09cc53 100644 --- a/modules/ROOT/pages/errors/gql-errors/08N21.adoc +++ b/modules/ROOT/pages/errors/gql-errors/08N21.adoc @@ -1,7 +1,7 @@ = 08N21 == Status description -error: connection exception - shard execution client error. Communication with shard `{ <> }` failed. with message `{ <> }`. +error: connection exception - shard execution client error. Communication with shard `{ <> }` failed with message `{ <> }`. ifndef::backend-pdf[] diff --git a/modules/ROOT/pages/errors/gql-errors/22NBA.adoc b/modules/ROOT/pages/errors/gql-errors/22NBA.adoc new file mode 100644 index 00000000..32995052 --- /dev/null +++ b/modules/ROOT/pages/errors/gql-errors/22NBA.adoc @@ -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 +---- + +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::[] \ No newline at end of file diff --git a/modules/ROOT/pages/errors/gql-errors/22NBC.adoc b/modules/ROOT/pages/errors/gql-errors/22NBC.adoc new file mode 100644 index 00000000..600270ba --- /dev/null +++ b/modules/ROOT/pages/errors/gql-errors/22NBC.adoc @@ -0,0 +1,21 @@ += 22NBC + +== Status description + +error: data exception - index belongs to constraint. Index belongs to constraint `{ <> }`. + +== 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::[] \ No newline at end of file diff --git a/modules/ROOT/pages/errors/gql-errors/42NA8.adoc b/modules/ROOT/pages/errors/gql-errors/42NA8.adoc index 869560ab..81b23710 100644 --- a/modules/ROOT/pages/errors/gql-errors/42NA8.adoc +++ b/modules/ROOT/pages/errors/gql-errors/42NA8.adoc @@ -3,6 +3,38 @@ == Status description error: syntax error or access rule violation - invalid reference in command. Invalid reference in command `{ <> }`. +== 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 diff --git a/modules/ROOT/pages/errors/gql-errors/51N31.adoc b/modules/ROOT/pages/errors/gql-errors/51N31.adoc index f26d753f..376080c6 100644 --- a/modules/ROOT/pages/errors/gql-errors/51N31.adoc +++ b/modules/ROOT/pages/errors/gql-errors/51N31.adoc @@ -1,8 +1,10 @@ +:page-role: changed-2025.06 + = 51N31 == Status description -error: system configuration or operation exception - not supported. `{ <> }` is not supported in `{ <> }`. +error: system configuration or operation exception - not supported. `{ <> }` is not supported in `{ <> }`. ifndef::backend-pdf[] diff --git a/modules/ROOT/pages/errors/gql-errors/51N41.adoc b/modules/ROOT/pages/errors/gql-errors/51N41.adoc index d6bf25db..a6534876 100644 --- a/modules/ROOT/pages/errors/gql-errors/51N41.adoc +++ b/modules/ROOT/pages/errors/gql-errors/51N41.adoc @@ -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: `{ <> }` ifndef::backend-pdf[] [discrete.glossary] diff --git a/modules/ROOT/pages/errors/gql-errors/index.adoc b/modules/ROOT/pages/errors/gql-errors/index.adoc index 836d4711..43f4daf0 100644 --- a/modules/ROOT/pages/errors/gql-errors/index.adoc +++ b/modules/ROOT/pages/errors/gql-errors/index.adoc @@ -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 `{ <> }` failed. with message `{ <> }`. +Status description:: error: connection exception - shard execution transient error. Communication with shard `{ <> }` failed with message `{ <> }`. === xref:errors/gql-errors/08N20.adoc[08N20] -Status description:: error: connection exception - shard execution database error. Communication with shard `{ <> }` failed. with message `{ <> }`. +Status description:: error: connection exception - shard execution database error. Communication with shard `{ <> }` failed with message `{ <> }`. === xref:errors/gql-errors/08N21.adoc[08N21] -Status description:: error: connection exception - shard execution client error. Communication with shard `{ <> }` failed. with message `{ <> }`. +Status description:: error: connection exception - shard execution client error. Communication with shard `{ <> }` failed with message `{ <> }`. [[data-exceptions]] @@ -611,6 +611,14 @@ Status description:: error: data exception - invalid Neo4j type. `{ <> }` Status description:: error: data exception - invalid inner list type. Lists cannot have `{ <> }` 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 `{ <> }`. + [[invalid-transaction-state]] == Invalid transaction state @@ -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 `{ <> }` 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 `{ <> }` 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 `{ <> }` 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 `{ <> }` 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 `{ <> }` function must contain one relationship pattern. @@ -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. `{ <> }` is not supported in `{ <> }`. +[role=label--changed-2025.06] === xref:errors/gql-errors/51N31.adoc[51N31] -Status description:: error: system configuration or operation exception - not supported. `{ <> }` is not supported in `{ <> }`. +Status description:: error: system configuration or operation exception - not supported. `{ <> }` is not supported in `{ <> }`. === xref:errors/gql-errors/51N32.adoc[51N32] @@ -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: `{ <> }` === xref:errors/gql-errors/51N43.adoc[51N43] diff --git a/modules/ROOT/pages/notifications/all-notifications.adoc b/modules/ROOT/pages/notifications/all-notifications.adoc index 81b69aa8..9b7f2912 100644 --- a/modules/ROOT/pages/notifications/all-notifications.adoc +++ b/modules/ROOT/pages/notifications/all-notifications.adoc @@ -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 `{ <>1 }`, `{ <>2 }` is used. -Cause: `{ <> }`. -|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