You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-memrec.adoc
+31-29Lines changed: 31 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,57 +9,59 @@ You can use the `neo4j-admin server memory-recommendation` command to get an ini
9
9
The `neo4j-admin server memory-recommendation` command has the following syntax:
10
10
11
11
----
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>]
17
14
[--memory=<size>]
18
15
----
19
16
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.
21
20
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
+
25
25
The argument `--docker` outputs environmental variables that can be passed to a Neo4j Docker container.
26
26
For a detailed example, see xref:docker/operations.adoc#docker-neo4j-memrec[Use Neo4j Admin for memory recommendations].
27
27
28
-
== Options
28
+
=== Options
29
29
30
30
The `neo4j-admin server memory-recommendation` command has the following options:
31
31
32
-
.Options
33
-
[options="header", cols="1a,2m,3a"]
32
+
.`neo4j-admin server memory-recommendation` options
33
+
[options="header", cols="5m,6a,4m"]
34
34
|===
35
35
| Option
36
-
| Default
37
36
| Description
37
+
| Default
38
38
39
-
| `-h`, `--help`
40
-
|
41
-
| Show this help message and exit.
39
+
|--additional-config=<file>
40
+
|Configuration file with additional configuration.
41
+
|
42
42
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.
44
48
|
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.
47
49
48
-
| `--expand-commands`
50
+
|--expand-commands
51
+
|Allow command expansion in config value evaluation.
49
52
|
50
-
| Expand the commands to be run.
51
53
52
-
| `--verbose`
54
+
|-h, --help
55
+
|Show this help message and exit.
53
56
|
54
-
| Enable verbose output.
55
57
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.
59
61
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`.
0 commit comments