Skip to content

Commit

Permalink
Add GQL status to RuntimeUnsupportedWarning (#152)
Browse files Browse the repository at this point in the history
Co-authored-by: Reneta Popova <[email protected]>
Co-authored-by: Louise Berglund <[email protected]>
  • Loading branch information
3 people authored Jul 2, 2024
1 parent d626733 commit 2239466
Showing 1 changed file with 65 additions and 4 deletions.
69 changes: 65 additions & 4 deletions modules/ROOT/pages/notifications/all-notifications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1362,7 +1362,13 @@ Notifications with the unsupported category are created if the query or command
[#_neo_clientnotification_statement_runtimeunsupportedwarning]
=== RuntimeUnsupportedWarning

.Notification details
==== Notification details

[.tabbed-example]
=====
[.include-with-neo4j-code]
======

[cols="<1s,<4"]
|===
|Neo4j code
Expand All @@ -1375,8 +1381,31 @@ m|WARNING
m|UNSUPPORTED
|===

.The chosen runtime is not supported for the given query
====
======
[.include-with-GQLSTATUS-code]
======

[cols="<1s,<4"]
|===
|GQLSTATUS code
m|01N40
|StatusDescription
a|warn: unsupported runtime. The query cannot be executed with `$preparser_input1`, `$preparser_input2` is used. Cause: `$msg`.
|Severity
m|WARNING
|Classification
m|UNSUPPORTED
|===
======
=====

==== Example of a runtime not supported by a Cypher command

[.tabbed-example]
=====
[.include-with-neo4j-code]
======

Query::
+
[source,cypher]
Expand All @@ -1395,11 +1424,43 @@ Use a different runtime or remove the runtime option to run the query with the d
----
SHOW INDEXES YIELD *
----
====

======
[.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 *
----
======
=====

[#_neo_clientnotification_statement_runtimeexperimental]
=== RuntimeExperimental

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

.Notification details
[cols="<1s,<4"]
|===
Expand Down

0 comments on commit 2239466

Please sign in to comment.