Skip to content

Commit f931125

Browse files
committed
Update System Requirements section in Installation
1 parent 032d42b commit f931125

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

doc/modules/ROOT/pages/installation/System-requirements.adoc

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,24 @@ image::memory-usage.png[width=600]
1515
=== Heap size
1616

1717
The heap space is used for storing graph projections in the graph catalog and algorithm state.
18+
19+
[.tabbed-example, caption = ]
20+
====
21+
22+
[.include-with-neo4j-5x]
23+
=====
24+
When writing algorithm results back to Neo4j, heap space is also used for handling transaction state (see https://neo4j.com/docs/operations-manual/5/reference/configuration-settings/#config_db.tx_state.memory_allocation[dbms.tx_state.memory_allocation]).
25+
For purely analytical workloads, a general recommendation is to set the heap space to about 90% of the available main memory.
26+
This can be done via https://neo4j.com/docs/operations-manual/5/reference/configuration-settings/#config_server.memory.heap.initial_size[server.memory.heap.initial_size] and https://neo4j.com/docs/operations-manual/5/reference/configuration-settings/#config_server.memory.heap.max_size[server.memory.heap.max_size].
27+
=====
28+
29+
[.include-with-neo4j-4x]
30+
=====
1831
When writing algorithm results back to Neo4j, heap space is also used for handling transaction state (see https://neo4j.com/docs/operations-manual/{neo4j-docs-link-version}/reference/configuration-settings/#config_dbms.tx_state.memory_allocation[dbms.tx_state.memory_allocation]).
1932
For purely analytical workloads, a general recommendation is to set the heap space to about 90% of the available main memory.
2033
This can be done via https://neo4j.com/docs/operations-manual/{neo4j-docs-link-version}/reference/configuration-settings/#config_dbms.memory.heap.initial_size[dbms.memory.heap.initial_size] and https://neo4j.com/docs/operations-manual/{neo4j-docs-link-version}/reference/configuration-settings/#config_dbms.memory.heap.max_size[dbms.memory.heap.max_size].
34+
=====
35+
====
2136

2237
To better estimate the heap space required to project graphs and run algorithms, consider the xref:common-usage/memory-estimation.adoc[Memory Estimation] feature.
2338
The feature estimates the memory consumption of all involved data structures using information about number of nodes and relationships from the Neo4j count store.
@@ -26,7 +41,24 @@ The feature estimates the memory consumption of all involved data structures usi
2641

2742
The page cache is used to cache the Neo4j data and will help to avoid costly disk access.
2843

29-
For purely analytical workloads including xref:management-ops/projections/graph-project.adoc[native projections], it is recommended to decrease https://neo4j.com/docs/operations-manual/{neo4j-docs-link-version}/reference/configuration-settings/#config_dbms.memory.pagecache.size[dbms.memory.pagecache.size] in favor of an increased heap size.
44+
For purely analytical workloads including xref:management-ops/projections/graph-project.adoc[native projections], it is recommended to decrease the configured PageCache in favor of an increased heap size.
45+
46+
[.tabbed-example, caption = ]
47+
====
48+
49+
[.include-with-neo4j-5x]
50+
=====
51+
To configure the PageCache size you can use the following Neo4j configuration property
52+
https://neo4j.com/docs/operations-manual/5/reference/configuration-settings/#config_server.memory.pagecache.size[server.memory.pagecache.size]
53+
=====
54+
55+
[.include-with-neo4j-4x]
56+
=====
57+
To configure the PageCache size you can use the following Neo4j configuration property
58+
https://neo4j.com/docs/operations-manual/{neo4j-docs-link-version}/reference/configuration-settings/#config_dbms.memory.pagecache.size[dbms.memory.pagecache.size]
59+
=====
60+
====
61+
3062
However, setting a minimum page cache size is still important when projecting graphs:
3163

3264
* For xref:management-ops/projections/graph-project.adoc[native projections], the minimum page cache size for projecting a graph can be roughly estimated by `8KB * 100 * readConcurrency`.

0 commit comments

Comments
 (0)