Skip to content

Commit 7588f0c

Browse files
Align cypher shell with the codebase (#2327)
Co-authored-by: Stefano Ottolenghi <stefano.ottolenghi@neo4j.com>
1 parent eef07f2 commit 7588f0c

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

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

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

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

6871
|-P PARAM, --param PARAM
69-
|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.
72+
|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.
7073
|[]
7174

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

7679
|--sample-rows SAMPLE-ROWS
77-
|Number of rows sampled to compute table widths (only for format=VERBOSE)
80+
|Number of rows sampled to compute table widths (only for format=VERBOSE).
7881
|1000
7982

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

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

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

111114
|--notifications
112-
|Enable query notifications in interactive mode.
115+
|Enable notifications in interactive mode.
113116
|false
114117

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

149152
| --encryption {true,false,default}
150-
| 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.
153+
| 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.
151154
| default
152155

153-
| -d DATABASE --database DATABASE
156+
| -d DATABASE, --database DATABASE
154157
| Database to connect to. Can also be specified using the environment variable NEO4J_DATABASE.
155158
|
156159

0 commit comments

Comments
 (0)