Skip to content

Align cypher shell with the codebase #2327

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 5 commits into from
May 20, 2025
Merged

Align cypher shell with the codebase #2327

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
610f3cc
Align cypher shell with the codebase
renetapopova May 7, 2025
852af9f
Update --history description
renetapopova May 7, 2025
a98e7b6
add default value to --enable-autocompletions
renetapopova May 7, 2025
8c6b6be
fix --format description
renetapopova May 7, 2025
c18b55b
--history description
stefano-ottolenghi May 8, 2025
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
37 changes: 20 additions & 17 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,9 +18,12 @@ 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}]
[--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]
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]
----

Expand Down Expand Up @@ -55,30 +58,30 @@ cypher-shell [-h] [-a ADDRESS] [-u USERNAME] [--impersonate IMPERSONATE] [-p PAS
| Exit and report failures at the end of the input when reading from a file.
|

| --enable-autocompletions
| Whether to enable Cypher autocompletions inside the CLI, which are disabled by default.
|
|--enable-autocompletions
|Whether to enable Cypher autocompletions inside the CLI. Completions can only be enabled for neo4j 5 and later.
|false

|--format {auto,verbose,plain}
|Desired output format. Displays the results in tabular format if you use the shell interactively and with minimal formatting if you use it for scripting. +
`verbose` displays results in a tabular format and prints statistics. +
`verbose` displays results in tabular format and prints statistics. +
`plain` displays data with minimal formatting.
|auto

|-P PARAM, --param PARAM
|Add a parameter to this session. Example: `-P '{a: 1}'`, `-P '{a: 1, b: duration({seconds: 1})}'`, or using arrow syntax `-P 'a => 1'`. This argument can be specified multiple times.
|Add a parameter to this session. Example: `-P '{a: 1}'` or `-P '{a: 1, b: duration({seconds: 1})}'`. This argument can be specified multiple times.
|[]

|--non-interactive
|Force non-interactive mode. Only useful when auto-detection fails (like on Windows).
|false

|--sample-rows SAMPLE-ROWS
|Number of rows sampled to compute table widths (only for format=VERBOSE)
|Number of rows sampled to compute table widths (only for format=VERBOSE).
|1000

|--wrap {true,false}
|Wrap table column values if the column is too narrow (only for format=VERBOSE).
|Wrap table column values if column is too narrow (only for format=VERBOSE).
|true

|-v, --version
Expand All @@ -102,14 +105,14 @@ After executing all statements, Cypher Shell shuts down.
|Enable logging to the specified file, or standard error if the file is omitted.
|

|--history [HISTORY-BEHAVIOUR]
|File path of query and command history file or `in-memory` for in-memory history.
Defaults to <user home>/.neo4j/.cypher_shell_history.
It can also be set using the environmental variable NEO4J_CYPHER_SHELL_HISTORY.
|--history HISTORY-BEHAVIOUR
|File path of a query and a command history file or `in-memory` for in-memory history.
If the option is omitted, history is saved to `<user home>/.neo4j/.cypher_shell_history`.
Can also be set using the environment variable `NEO4J_CYPHER_SHELL_HISTORY`.
|

|--notifications
|Enable query notifications in interactive mode.
|Enable notifications in interactive mode.
|false

|--idle-timeout IDLE-TIMEOUT
Expand Down Expand Up @@ -147,10 +150,10 @@ Can also be specified using the environment variable `NEO4J_ADDRESS` or `NEO4J_U
|

| --encryption {true,false,default}
| Whether the connection to Neo4j should be encrypted. This must be consistent with Neo4j's configuration. If choosing `default`, the encryption setting is deduced from the specified address. For example, the `neo4j+ssc` protocol uses encryption.
| Whether the connection to Neo4j should be encrypted. This must be consistent with the Neo4j's configuration. If choosing 'default', the encryption setting is deduced from the specified address. For example, the 'neo4j+ssc' protocol uses encryption.
| default

| -d DATABASE --database DATABASE
| -d DATABASE, --database DATABASE
| Database to connect to. Can also be specified using the environment variable NEO4J_DATABASE.
|

Expand Down