@@ -29,12 +29,17 @@ The metadata contains the following information:
2929
3030[source,role=noheader]
3131----
32- neo4j-admin backup inspect [-h] [--empty] [--expand-commands] [--latest-backup]
33- [--latest-chain] [--show-metadata] [--verbose]
34- [--additional-config=<file>] [--database=<database>]
35- [--format=<value>] <backup-path>
32+ neo4j-admin backup inspect [-h] [--empty] [--expand-commands] [--latest-backup] [--latest-chain]
33+ [--verbose] [--additional-config=<file>] [--database=<database>] [--format=<value>]
34+ <backup-path>
3635----
3736
37+ [NOTE]
38+ ====
39+ Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command.
40+ If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata.
41+ ====
42+
3843=== Description
3944
4045Command to read the backup metadata.
@@ -87,10 +92,6 @@ The `<backup-path>` parameter can also inspect backups stored in AWS S3 buckets,
8792| List the full backup chain ending with the latest downloaded backup.
8893| false
8994
90- | --show-metadata
91- | Show the backup metadata.
92- | false
93-
9495| --database=<database>
9596| Name of the database to inspect.
9697|
@@ -113,6 +114,12 @@ The `<backup-path>` parameter can also inspect backups stored in AWS S3 buckets,
113114The `--latest-backup` and `--latest-chain` options cannot be used together.
114115====
115116
117+ [NOTE]
118+ ====
119+ Starting with Neo4j 2025.07, the `--show-metadata` option is deprecated and ignored.
120+ The backup metadata is always shown by default when using the `neo4j-admin backup inspect` command.
121+ However, if you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata.
122+ ====
116123
117124[[aggregate-backup-example]]
118125== Examples
@@ -140,7 +147,7 @@ The following command lists the backup files' names along with their respective
140147
141148[source,shell]
142149----
143- bin/neo4j-admin backup inspect /backups --show-metadata -- empty
150+ bin/neo4j-admin backup inspect /backups --empty
144151----
145152
146153The `--empty` option is used to include the empty backups.
@@ -163,13 +170,19 @@ Empty backups are used to record the backup history.
163170| file:///backups/london-2024-10-07T16-03-51.backup | london | d4dae73c-dfef-4d28-88cd-fe6cc88ddca1 | 2024-10-07T16:03:51 | true | true | 1 | 5 | true |
164171----
165172
173+ [NOTE]
174+ ====
175+ Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command.
176+ If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata.
177+ ====
178+
166179=== Listing the latest backups
167180
168181To list only the most recent backups performed for each database, use the `--latest-backup` option.
169182
170183[source,shell]
171184----
172- bin/neo4j-admin backup inspect /backups --show-metadata -- latest-backup
185+ bin/neo4j-admin backup inspect /backups --latest-backup
173186----
174187
175188.Example output
@@ -181,14 +194,20 @@ bin/neo4j-admin backup inspect /backups --show-metadata --latest-backup
181194| file:///backups/london-2024-10-07T16-04-05.backup | london | d4dae73c-dfef-4d28-88cd-fe6cc88ddca1 | 2024-10-07T16:04:05 | false | true | 6 | 6 | false |
182195----
183196
197+ [NOTE]
198+ ====
199+ 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+
184203=== Inspecting backup chains
185204
186205A backup chain corresponds to a sequence of one or more backup(s) logically connected by their transaction IDs.
187206To 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:
188207
189208[source,shell]
190209----
191- bin/neo4j-admin backup inspect /backups --show-metadata -- latest-chain --database=london
210+ bin/neo4j-admin backup inspect /backups --latest-chain --database=london
192211----
193212
194213.Example output
@@ -206,14 +225,19 @@ The result returns a chain of size two:
206225Those modifications are materialised by a sequence of transactions to apply.
207226Its range is [6,6].
208227
228+ [NOTE]
229+ ====
230+ Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command.
231+ If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata.
232+ ====
209233
210234=== Inspecting a backup chain ending with a specific backup
211235
212236To inspect a backup chain ending with a specific backup, use the `--latest-chain` option as follows:
213237
214238[source,shell]
215239----
216- bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --show-metadata --latest-chain
240+ bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --latest-chain
217241----
218242
219243.Example output
@@ -229,6 +253,12 @@ bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --sho
229253In 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_.
230254====
231255
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.
260+ ====
261+
232262
233263
234264
0 commit comments