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
Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command.
200
+
If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata.
201
+
====
202
+
184
203
=== Inspecting backup chains
185
204
186
205
A backup chain corresponds to a sequence of one or more backup(s) logically connected by their transaction IDs.
187
206
To inspect the backup chains of a given database, use the `--latest-chain` option and the `--database` option with the database whose backup chain you want to inspect:
In this case, the `--database` option is unnecessary because the database identifier is part of the metadata stored in the header of the backup file _london-2024-10-07T16-04-05.backup_.
230
254
====
231
255
256
+
[NOTE]
257
+
====
258
+
Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command.
259
+
If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/configuration/command-expansion.adoc
+19-2Lines changed: 19 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,14 +41,31 @@ Scripts and their syntax differ between operating systems.
41
41
42
42
== Enabling
43
43
44
-
The Neo4j startup script and the `neo4j` service can expand and execute the external commands by using the argument `--expand-commands`.
44
+
To enable command expansion, you must add the `--expand-commands` argument to the Neo4j startup script or _neo4j.service_ file.
45
+
46
+
=== Starting Neo4j with command expansion
47
+
48
+
To start Neo4j with command expansion enabled, you can use the following command:
45
49
46
50
[source, shell]
47
51
----
48
52
bin/neo4j start --expand-commands
49
53
----
50
54
51
-
If the startup script does not receive the `--expand-commands` argument, commands in the configuration file are treated as invalid settings.
55
+
=== Enabling command expansion in Neo4j as a service
56
+
57
+
If you are using Neo4j as a service, you can enable command expansion by adding the `--expand-commands` argument to the _/etc/systemd/system/neo4j.service_ file.
58
+
Otherwise, the commands in the configuration file are treated as invalid settings.
59
+
60
+
You must also add `Type=forking` under the `[Service]` section of _/etc/systemd/system/neo4j.service_ to allow for the command expansion.
61
+
62
+
[source]
63
+
----
64
+
[Service]
65
+
Type=forking
66
+
----
67
+
68
+
=== Security checks
52
69
53
70
Neo4j performs the following basic security checks on the _neo4j.conf_ file.
54
71
If they fail, Neo4j does not evaluate the script commands in _neo4j.conf_, and the Neo4j process does not start.
a|Limit the write throughput per second of the background checkpoint process. This setting is advisory. It is ignored in Neo4j Community Edition and is followed to best effort in Enterprise Edition. Limiting the write IO in this way leaves more bandwidth in the IO subsystem to service random-read IOs, which is important for the response time of queries when the database cannot fit entirely in memory. The only drawback of this setting is that longer checkpoint times may lead to slightly longer recovery times in case of a database or system crash. A lower number means lower IO pressure and, consequently, longer checkpoint times. Set this to null to disable the throughput limit and fallback to IOPS limit.
197
+
|Valid values
198
+
a|A byte size (valid multipliers are B, KiB, KB, K, kB, kb, k, MiB, MB, M, mB, mb, m, GiB, GB, G, gB, gb, g, TiB, TB, PiB, PB, EiB, EB) that is minimum 8.00KiB.
199
+
|Default value
200
+
m|++++++
201
+
|===
202
+
187
203
== Cloud storage integration settings
188
204
189
205
Cloud integration settings allow you to specify custom Azure blob storage endpoints and host authorities, set the project ID for Google Cloud Storage buckets, and define the desired throughput for transfer operations in Amazon S3.
@@ -1825,7 +1841,7 @@ For more information, see xref:/performance/statistics-execution-plans.adoc[Stat
1825
1841
|Description
1826
1842
a|The default language of a database determines which language is used to evaluate queries that do not explicitly select a language. This setting determines the default language used for new (and initial) databases where not specified as part of `CREATE` or `ALTER` database.
1827
1843
|Valid values
1828
-
a|One of [CYPHER_5, CYPHER_25] that the [] values acceptance depend on 'internal.dbms.cypher.enable_experimental_versions'.
1844
+
a|One of [CYPHER_5, CYPHER_25]. label:changed[Changed in 2025.07]
Copy file name to clipboardExpand all lines: modules/ROOT/pages/database-internals/checkpointing.adoc
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,42 +115,42 @@ The following details the expected messages to appear in the _logs\debug.log_ up
115
115
+
116
116
....
117
117
2023-05-28 12:55:05.174+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Scheduled checkpoint for time threshold" @ txId: 49 checkpoint started...
118
-
2023-05-28 12:55:05.253+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Scheduled checkpoint for time threshold" @ txId: 49 checkpoint completed in 79ms
118
+
2023-05-28 12:55:05.253+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Scheduled checkpoint for time threshold" @ txId: 49 checkpoint completed in 79ms. Checkpoint flushed 74 pages (7% of total available pages), in 58 IOs. Checkpoint performed with IO limit: 789 IOPS, paused in total 0 times(0 millis). Average checkpoint flush speed: 592.0KiB/s.
119
119
....
120
120
121
121
* Checkpoint based upon `db.checkpoint.interval.tx`:
122
122
+
123
123
....
124
124
2023-05-28 13:08:51.603+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Scheduled checkpoint for tx count threshold" @ txId: 118 checkpoint started...
125
-
2023-05-28 13:08:51.669+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Scheduled checkpoint for tx count threshold" @ txId: 118 checkpoint completed in 66ms
125
+
2023-05-28 13:08:51.669+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Scheduled checkpoint for tx count threshold" @ txId: 118 checkpoint completed in 66ms. Checkpoint flushed 74 pages (7% of total available pages), in 58 IOs. Checkpoint performed with IO limit: 789 IOPS, paused in total 0 times(0 millis). Average checkpoint flush speed: 592.0KiB/s.
126
126
....
127
127
128
128
* Checkpoint when `db.checkpoint=continuous`:
129
129
+
130
130
....
131
131
2023-05-28 13:17:21.927+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Scheduled checkpoint for continuous threshold" @ txId: 171 checkpoint started...
132
-
2023-05-28 13:17:21.941+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Scheduled checkpoint for continuous threshold" @ txId: 171 checkpoint completed in 13ms
132
+
2023-05-28 13:17:21.941+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Scheduled checkpoint for continuous threshold" @ txId: 171 checkpoint completed in 13ms. Checkpoint flushed 74 pages (7% of total available pages), in 58 IOs. Checkpoint performed with IO limit: 789 IOPS, paused in total 0 times(0 millis). Average checkpoint flush speed: 592.0KiB/s.
133
133
....
134
134
135
135
* Checkpoint as a result of database shutdown:
136
136
+
137
137
....
138
138
2023-05-28 12:35:56.272+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Database shutdown" @ txId: 47 checkpoint started...
139
-
2023-05-28 12:35:56.306+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Database shutdown" @ txId: 47 checkpoint completed in 34ms
139
+
2023-05-28 12:35:56.306+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Database shutdown" @ txId: 47 checkpoint completed in 34ms. Checkpoint flushed 74 pages (7% of total available pages), in 58 IOs. Checkpoint performed with IO limit: 789 IOPS, paused in total 0 times(0 millis). Average checkpoint flush speed: 592.0KiB/s.
140
140
....
141
141
142
142
* Checkpoint as a result of `CALL db.checkpoint()`:
143
143
+
144
144
....
145
145
2023-05-28 12:31:56.463+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Call to db.checkpoint() procedure" @ txId: 47 checkpoint started...
146
-
2023-05-28 12:31:56.490+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Call to db.checkpoint() procedure" @ txId: 47 checkpoint completed in 27ms
146
+
2023-05-28 12:31:56.490+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Call to db.checkpoint() procedure" @ txId: 47 checkpoint completed in 27ms. Checkpoint flushed 74 pages (7% of total available pages), in 58 IOs. Checkpoint performed with IO limit: 789 IOPS, paused in total 0 times(0 millis). Average checkpoint flush speed: 592.0KiB/s.
147
147
....
148
148
149
149
* Checkpoint as a result of a backup run:
150
150
+
151
151
....
152
152
2023-05-28 12:33:30.489+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Full backup" @ txId: 47 checkpoint started...
153
-
2023-05-28 12:33:30.509+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Full backup" @ txId: 47 checkpoint completed in 20ms
153
+
2023-05-28 12:33:30.509+0000 INFO [o.n.k.i.t.l.c.CheckPointerImpl] Checkpoint triggered by "Full backup" @ txId: 47 checkpoint completed in 20ms. Checkpoint flushed 74 pages (7% of total available pages), in 58 IOs. Checkpoint performed with IO limit: 789 IOPS, paused in total 0 times(0 millis). Average checkpoint flush speed: 592.0KiB/s.
154
154
....
155
155
156
156
https://neo4j.com/docs/operations-manual/current/monitoring/metrics/reference/#metrics-general-purpose[Checkpoint Metrics] are also available and are detailed in the following files, in the _metrics/_ directory:
0 commit comments