Skip to content

Commit 5075907

Browse files
authored
Update neo4j-admin server memory-recommendation syntax and options to reflect the code (#691) (#698)
Cherry-picked from #691
1 parent 5333a3f commit 5075907

File tree

1 file changed

+31
-29
lines changed

1 file changed

+31
-29
lines changed

modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-memrec.adoc

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -9,57 +9,59 @@ You can use the `neo4j-admin server memory-recommendation` command to get an ini
99
The `neo4j-admin server memory-recommendation` command has the following syntax:
1010

1111
----
12-
neo4j-admin server memory-recommendation [-h]
13-
[--docker]
14-
[--expand-commands]
15-
[--verbose]
16-
[--additional-config=<file>]
12+
neo4j-admin server memory-recommendation [-h] [--docker] [--expand-commands]
13+
[--verbose] [--additional-config=<file>]
1714
[--memory=<size>]
1815
----
1916

20-
The command gives heuristic memory settings recommendations for the Neo4j JVM heap and pagecache.
17+
=== Description
18+
19+
The command prints heuristic memory settings recommendations for the Neo4j JVM heap and pagecache.
2120
It either uses the total system memory or the amount of memory specified in the `--memory` argument.
22-
The heuristic also assumes that the system is dedicated to running Neo4j.
23-
If this is not the case, then use the `--memory` argument to specify how much memory can be expected to be dedicated to Neo4j.
24-
The default output is formatted so you can copy and paste it into xref:configuration/file-locations.adoc[_neo4j.conf_].
21+
The heuristic assumes that the system is dedicated to running Neo4j.
22+
If this is not the case, then use the --memory argument to specify how much memory can be expected to be dedicated to Neo4j.
23+
The output is formatted such that it can be copy-pasted into the _neo4j.conf_ file.
24+
2525
The argument `--docker` outputs environmental variables that can be passed to a Neo4j Docker container.
2626
For a detailed example, see xref:docker/operations.adoc#docker-neo4j-memrec[Use Neo4j Admin for memory recommendations].
2727

28-
== Options
28+
=== Options
2929

3030
The `neo4j-admin server memory-recommendation` command has the following options:
3131

32-
.Options
33-
[options="header", cols="1a,2m,3a"]
32+
.`neo4j-admin server memory-recommendation` options
33+
[options="header", cols="5m,6a,4m"]
3434
|===
3535
| Option
36-
| Default
3736
| Description
37+
| Default
3838

39-
| `-h`, `--help`
40-
|
41-
| Show this help message and exit.
39+
|--additional-config=<file>
40+
|Configuration file with additional configuration.
41+
|
4242

43-
| `--docker`
43+
|--docker
44+
|The recommended memory settings are produced in the form of environment variables that can be
45+
directly passed to a Neo4j docker container. The recommended use is to save the generated
46+
environment variables to a file and pass the file to a docker container using `--env-file`
47+
docker option.
4448
|
45-
| Enable output formatted as environmental variables that can be passed to a Neo4j Docker container.
46-
The recommended use is to save the generated environment variables to a file and pass that file to a Docker container using `--env-file` Docker option.
4749

48-
| `--expand-commands`
50+
|--expand-commands
51+
|Allow command expansion in config value evaluation.
4952
|
50-
| Expand the commands to be run.
5153

52-
| `--verbose`
54+
|-h, --help
55+
|Show this help message and exit.
5356
|
54-
| Enable verbose output.
5557

56-
| `--additional-config`
57-
| `<file>`
58-
| Configuration file to supply additional configuration in.
58+
|--memory=<size>
59+
|Recommend memory settings with respect to the given amount of memory, instead of the total memory of the system running the command. Valid units are: `k`, `K`, `m`, `M`, `g`, `G`.
60+
|The memory capacity of the machine.
5961

60-
| `--memory`
61-
| `<size>` (Default: The memory capacity of the machine.)
62-
| Recommend memory settings for the given amount of memory, instead of the total memory of the system running the command. Valid units are: `k`, `K`, `m`, `M`, `g`, `G`.
62+
|--verbose
63+
|Enable verbose output.
64+
|
6365
|===
6466

6567
== Considerations

0 commit comments

Comments
 (0)