Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GQL status to RuntimeUnsupportedWarning #152

Merged
Changes from 1 commit
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
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 @@ -1011,7 +1011,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 @@ -1024,8 +1030,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: runtime unsupported. The query cannot be executed with `$preparser_input1`, `preparser_input2` is used. Cause: `$msg`.
renetapopova marked this conversation as resolved.
Show resolved Hide resolved
|Severity
m|WARNING
|Classification
m|UNSUPPORTED
|===
======
=====

==== Example of an unsupported runtime for the given query
NataliaIvakina marked this conversation as resolved.
Show resolved Hide resolved

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

Query::
+
[source,cypher]
Expand All @@ -1044,11 +1073,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]
----
CYPHER runtime=pipelined SHOW INDEXES YIELD *
NataliaIvakina marked this conversation as resolved.
Show resolved Hide resolved
----

Returned GQLSTATUS code::
01N40

Returned Status Description::
warn: runtime unsupported.
renetapopova marked this conversation as resolved.
Show resolved Hide resolved
The query cannot be executed with `runtime=pipelined` is used.
NataliaIvakina marked this conversation as resolved.
Show resolved Hide resolved
Cause: `PIPELINED`.
renetapopova marked this conversation as resolved.
Show resolved Hide resolved

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

[WARN]
NataliaIvakina marked this conversation as resolved.
Show resolved Hide resolved
NataliaIvakina marked this conversation as resolved.
Show resolved Hide resolved
====
The usage of this notification has been removed since Neo4j 5.14.
====

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