Skip to content

Commit 610f3cc

Browse files
committed
Align cypher shell with the codebase
1 parent ae815b9 commit 610f3cc

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

modules/ROOT/pages/cypher-shell.adoc

Lines changed: 14 additions & 10 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

@@ -56,7 +59,7 @@ cypher-shell [-h] [-a ADDRESS] [-u USERNAME] [--impersonate IMPERSONATE] [-p PAS
5659
|
5760

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

6265
|--format {auto,verbose,plain}
@@ -66,19 +69,20 @@ cypher-shell [-h] [-a ADDRESS] [-u USERNAME] [--impersonate IMPERSONATE] [-p PAS
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.
73+
7074
|[]
7175

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

7680
|--sample-rows SAMPLE-ROWS
77-
|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).
7882
|1000
7983

8084
|--wrap {true,false}
81-
|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).
8286
|true
8387

8488
|-v, --version
@@ -109,7 +113,7 @@ It can also be set using the environmental variable NEO4J_CYPHER_SHELL_HISTORY.
109113
|
110114

111115
|--notifications
112-
|Enable query notifications in interactive mode.
116+
|Enable notifications in interactive mode.
113117
|false
114118

115119
|--idle-timeout IDLE-TIMEOUT
@@ -147,10 +151,10 @@ Can also be specified using the environment variable `NEO4J_ADDRESS` or `NEO4J_U
147151
|
148152

149153
| --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.
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.
151155
| default
152156

153-
| -d DATABASE --database DATABASE
157+
| -d DATABASE, --database DATABASE
154158
| Database to connect to. Can also be specified using the environment variable NEO4J_DATABASE.
155159
|
156160

0 commit comments

Comments
 (0)