From aa13f8540b4a908968020a1a723e204a3ad5869d Mon Sep 17 00:00:00 2001 From: Natalia Ivakina Date: Tue, 25 Jun 2024 16:55:47 +0200 Subject: [PATCH 1/5] Add GQL status to `RuntimeUnsupportedWarning` --- .../notifications/all-notifications.adoc | 69 +++++++++++++++++-- 1 file changed, 65 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/notifications/all-notifications.adoc b/modules/ROOT/pages/notifications/all-notifications.adoc index 61b5c106..68cf850c 100644 --- a/modules/ROOT/pages/notifications/all-notifications.adoc +++ b/modules/ROOT/pages/notifications/all-notifications.adoc @@ -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 @@ -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`. +|Severity +m|WARNING +|Classification +m|UNSUPPORTED +|=== +====== +===== + +==== Example of an unsupported runtime for the given query + +[.tabbed-example] +===== +[.include-with-neo4j-code] +====== + Query:: + [source,cypher] @@ -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 * +---- + +Returned GQLSTATUS code:: +01N40 + +Returned Status Description:: +warn: runtime unsupported. +The query cannot be executed with `runtime=pipelined` is used. +Cause: `PIPELINED`. + +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] +==== +The usage of this notification has been removed since Neo4j 5.14. +==== + .Notification details [cols="<1s,<4"] |=== From f75d60f1b38445e3f6c3dc1e40123940e9dd1118 Mon Sep 17 00:00:00 2001 From: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Thu, 27 Jun 2024 16:08:13 +0200 Subject: [PATCH 2/5] Apply suggestions from code review Co-authored-by: Reneta Popova --- modules/ROOT/pages/notifications/all-notifications.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/notifications/all-notifications.adoc b/modules/ROOT/pages/notifications/all-notifications.adoc index 68cf850c..fdee32d5 100644 --- a/modules/ROOT/pages/notifications/all-notifications.adoc +++ b/modules/ROOT/pages/notifications/all-notifications.adoc @@ -1048,7 +1048,7 @@ m|UNSUPPORTED ====== ===== -==== Example of an unsupported runtime for the given query +==== Example of a runtime not supported by a Cypher command [.tabbed-example] ===== @@ -1081,7 +1081,7 @@ Query:: + [source,cypher] ---- -CYPHER runtime=pipelined SHOW INDEXES YIELD * +EXPLAIN CYPHER runtime=pipelined SHOW INDEXES YIELD * ---- Returned GQLSTATUS code:: @@ -1089,7 +1089,7 @@ Returned GQLSTATUS code:: Returned Status Description:: warn: runtime unsupported. -The query cannot be executed with `runtime=pipelined` is used. +The query cannot be executed with `runtime=pipelined`, `runtime=slotted` is used. Cause: `PIPELINED`. Suggestions for improvement:: @@ -1105,7 +1105,7 @@ SHOW INDEXES YIELD * [#_neo_clientnotification_statement_runtimeexperimental] === RuntimeExperimental -[WARN] +[NOTE] ==== The usage of this notification has been removed since Neo4j 5.14. ==== From b52da6de884b5bf261ee1ebcfa60bdbb2d28bbc6 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Mon, 1 Jul 2024 16:34:35 +0100 Subject: [PATCH 3/5] Update modules/ROOT/pages/notifications/all-notifications.adoc Co-authored-by: Louise Berglund --- modules/ROOT/pages/notifications/all-notifications.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/notifications/all-notifications.adoc b/modules/ROOT/pages/notifications/all-notifications.adoc index fdee32d5..df86e01c 100644 --- a/modules/ROOT/pages/notifications/all-notifications.adoc +++ b/modules/ROOT/pages/notifications/all-notifications.adoc @@ -1039,7 +1039,7 @@ m|UNSUPPORTED |GQLSTATUS code m|01N40 |StatusDescription -a|warn: runtime unsupported. The query cannot be executed with `$preparser_input1`, `preparser_input2` is used. Cause: `$msg`. +a|warn: unsupported runtime. The query cannot be executed with `$preparser_input1`, `$preparser_input2` is used. Cause: `$msg`. |Severity m|WARNING |Classification From 205b4c9ecf46f99175bf4f4f9229703c88afdef0 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Mon, 1 Jul 2024 16:34:43 +0100 Subject: [PATCH 4/5] Update modules/ROOT/pages/notifications/all-notifications.adoc Co-authored-by: Louise Berglund --- modules/ROOT/pages/notifications/all-notifications.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/notifications/all-notifications.adoc b/modules/ROOT/pages/notifications/all-notifications.adoc index df86e01c..84c526bb 100644 --- a/modules/ROOT/pages/notifications/all-notifications.adoc +++ b/modules/ROOT/pages/notifications/all-notifications.adoc @@ -1088,7 +1088,7 @@ Returned GQLSTATUS code:: 01N40 Returned Status Description:: -warn: runtime unsupported. +warn: unsupported runtime. The query cannot be executed with `runtime=pipelined`, `runtime=slotted` is used. Cause: `PIPELINED`. From 5f614bee86d28b952bef550934604e308f283819 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 2 Jul 2024 10:37:26 +0100 Subject: [PATCH 5/5] Update modules/ROOT/pages/notifications/all-notifications.adoc Co-authored-by: Louise Berglund --- modules/ROOT/pages/notifications/all-notifications.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/notifications/all-notifications.adoc b/modules/ROOT/pages/notifications/all-notifications.adoc index 84c526bb..2cd33ce2 100644 --- a/modules/ROOT/pages/notifications/all-notifications.adoc +++ b/modules/ROOT/pages/notifications/all-notifications.adoc @@ -1090,7 +1090,7 @@ Returned GQLSTATUS code:: Returned Status Description:: warn: unsupported runtime. The query cannot be executed with `runtime=pipelined`, `runtime=slotted` is used. -Cause: `PIPELINED`. +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: