Skip to content

Commit eff3918

Browse files
Align cypher shell with the codebase (#2327)
Co-authored-by: Stefano Ottolenghi <[email protected]>
1 parent dde68a1 commit eff3918

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

modules/ROOT/pages/cypher-shell.adoc

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

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

@@ -56,30 +59,30 @@ cypher-shell [-h] [-a ADDRESS] [-u USERNAME] [--impersonate IMPERSONATE] [-p PAS
5659
| Exit and report failures at the end of the input when reading from a file.
5760
|
5861

59-
| --enable-autocompletions
60-
| Whether to enable Cypher autocompletions inside the CLI, which are disabled by default.
61-
|
62+
|--enable-autocompletions
63+
|Whether to enable Cypher autocompletions inside the CLI. Completions can only be enabled for neo4j 5 and later.
64+
|false
6265

6366
|--format {auto,verbose,plain}
6467
|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. +
65-
`verbose` displays results in a tabular format and prints statistics. +
68+
`verbose` displays results in tabular format and prints statistics. +
6669
`plain` displays data with minimal formatting.
6770
|auto
6871

6972
|-P PARAM, --param PARAM
70-
|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.
73+
|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.
7174
|[]
7275

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

7780
|--sample-rows SAMPLE-ROWS
78-
|Number of rows sampled to compute table widths (only for format=VERBOSE)
81+
|Number of rows sampled to compute table widths (only for format=VERBOSE).
7982
|1000
8083

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

8588
|-v, --version
@@ -103,14 +106,14 @@ After executing all statements, Cypher Shell shuts down.
103106
|Enable logging to the specified file, or standard error if the file is omitted.
104107
|
105108

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

112115
|--notifications
113-
|Enable query notifications in interactive mode.
116+
|Enable notifications in interactive mode.
114117
|false
115118

116119
|--idle-timeout IDLE-TIMEOUT
@@ -148,10 +151,10 @@ Can also be specified using the environment variable `NEO4J_ADDRESS` or `NEO4J_U
148151
|
149152

150153
| --encryption {true,false,default}
151-
| 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.
154+
| 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.
152155
| default
153156

154-
| -d DATABASE --database DATABASE
157+
| -d DATABASE, --database DATABASE
155158
| Database to connect to. Can also be specified using the environment variable NEO4J_DATABASE.
156159
|
157160

0 commit comments

Comments
 (0)