Skip to content

Commit 39c34a3

Browse files
committed
Document --error-format argument to Cypher Shell (neo4j#2267)
1 parent 94de519 commit 39c34a3

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

modules/ROOT/pages/cypher-shell.adoc

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,10 @@ Alternatively, you can download it from link:https://neo4j.com/deployment-center
1818
The syntax for running Cypher Shell is:
1919

2020
----
21-
cypher-shell [-h] [-a ADDRESS]
22-
[-u USERNAME] [--impersonate IMPERSONATE]
23-
[-p PASSWORD] [--encryption {true,false,default}]
24-
[-d DATABASE] [--access-mode {read,write}]
25-
[--format {auto,verbose,plain}]
26-
[-P PARAM] [--non-interactive] [--sample-rows SAMPLE-ROWS]
27-
[--wrap {true,false}] [-v] [--driver-version]
28-
[-f FILE] [--change-password] [--log [LOG-FILE]]
29-
[--history HISTORY-BEHAVIOUR]
30-
[--notifications] [--fail-fast | --fail-at-end]
31-
[--idle-timeout IDLE-TIMEOUT]
32-
[cypher]
21+
cypher-shell [-h] [-a ADDRESS] [-u USERNAME] [--impersonate IMPERSONATE] [-p PASSWORD] [--encryption {true,false,default}] [-d DATABASE] [--access-mode {read,write}]
22+
[--enable-autocompletions] [--format {auto,verbose,plain}] [-P PARAM] [--non-interactive] [--sample-rows SAMPLE-ROWS] [--wrap {true,false}] [-v]
23+
[--driver-version] [-f FILE] [--change-password] [--log [LOG-FILE]] [--history HISTORY-BEHAVIOUR] [--notifications] [--idle-timeout IDLE-TIMEOUT]
24+
[--error-format {gql,legacy,stacktrace}] [--fail-fast | --fail-at-end] [cypher]
3325
----
3426

3527
== Positional arguments
@@ -123,6 +115,10 @@ It can also be set using the environmental variable NEO4J_CYPHER_SHELL_HISTORY.
123115
|--idle-timeout IDLE-TIMEOUT
124116
|Closes the application after the specified amount of idle time in interactive mode. You can specify the duration using the format `<hours>h<minutes>m<seconds>s`, for example `1h` (1 hour), `1h30m` (1 hour 30 minutes), or `30m` (30 minutes).
125117
|disable
118+
119+
|--error-format {gql,legacy,stacktrace}
120+
|Controls how errors are displayed.
121+
|legacy
126122
|===
127123

128124
== Connection arguments

0 commit comments

Comments
 (0)