Skip to content

Document --error-format argument to Cypher Shell (#2267) #2271

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 15, 2025
Merged

Document --error-format argument to Cypher Shell (#2267) #2271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 8 additions & 12 deletions modules/ROOT/pages/cypher-shell.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 `<hours>h<minutes>m<seconds>s`, 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
Expand Down