From 39c34a38659e11527abfad728b05a254ba0da350 Mon Sep 17 00:00:00 2001 From: Reneta Popova Date: Tue, 15 Apr 2025 13:51:23 +0100 Subject: [PATCH] Document --error-format argument to Cypher Shell (#2267) --- modules/ROOT/pages/cypher-shell.adoc | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/modules/ROOT/pages/cypher-shell.adoc b/modules/ROOT/pages/cypher-shell.adoc index 36936d24c..b6b3ec3ba 100644 --- a/modules/ROOT/pages/cypher-shell.adoc +++ b/modules/ROOT/pages/cypher-shell.adoc @@ -18,18 +18,10 @@ Alternatively, you can download it from link:https://neo4j.com/deployment-center The syntax for running Cypher Shell is: ---- - cypher-shell [-h] [-a ADDRESS] - [-u USERNAME] [--impersonate IMPERSONATE] - [-p PASSWORD] [--encryption {true,false,default}] - [-d DATABASE] [--access-mode {read,write}] - [--format {auto,verbose,plain}] - [-P PARAM] [--non-interactive] [--sample-rows SAMPLE-ROWS] - [--wrap {true,false}] [-v] [--driver-version] - [-f FILE] [--change-password] [--log [LOG-FILE]] - [--history HISTORY-BEHAVIOUR] - [--notifications] [--fail-fast | --fail-at-end] - [--idle-timeout IDLE-TIMEOUT] - [cypher] +cypher-shell [-h] [-a ADDRESS] [-u USERNAME] [--impersonate IMPERSONATE] [-p PASSWORD] [--encryption {true,false,default}] [-d DATABASE] [--access-mode {read,write}] + [--enable-autocompletions] [--format {auto,verbose,plain}] [-P PARAM] [--non-interactive] [--sample-rows SAMPLE-ROWS] [--wrap {true,false}] [-v] + [--driver-version] [-f FILE] [--change-password] [--log [LOG-FILE]] [--history HISTORY-BEHAVIOUR] [--notifications] [--idle-timeout IDLE-TIMEOUT] + [--error-format {gql,legacy,stacktrace}] [--fail-fast | --fail-at-end] [cypher] ---- == Positional arguments @@ -123,6 +115,10 @@ It can also be set using the environmental variable NEO4J_CYPHER_SHELL_HISTORY. |--idle-timeout IDLE-TIMEOUT |Closes the application after the specified amount of idle time in interactive mode. You can specify the duration using the format `hms`, for example `1h` (1 hour), `1h30m` (1 hour 30 minutes), or `30m` (30 minutes). |disable + +|--error-format {gql,legacy,stacktrace} +|Controls how errors are displayed. +|legacy |=== == Connection arguments