diff --git a/modules/ROOT/pages/backup-restore/inspect.adoc b/modules/ROOT/pages/backup-restore/inspect.adoc index 6e2998a69..59450dd17 100644 --- a/modules/ROOT/pages/backup-restore/inspect.adoc +++ b/modules/ROOT/pages/backup-restore/inspect.adoc @@ -29,12 +29,17 @@ The metadata contains the following information: [source,role=noheader] ---- -neo4j-admin backup inspect [-h] [--empty] [--expand-commands] [--latest-backup] - [--latest-chain] [--show-metadata] [--verbose] - [--additional-config=] [--database=] - [--format=] +neo4j-admin backup inspect [-h] [--empty] [--expand-commands] [--latest-backup] [--latest-chain] + [--verbose] [--additional-config=] [--database=] [--format=] + ---- +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== + === Description Command to read the backup metadata. @@ -87,10 +92,6 @@ The `` parameter can also inspect backups stored in AWS S3 buckets, | List the full backup chain ending with the latest downloaded backup. | false -| --show-metadata -| Show the backup metadata. -| false - | --database= | Name of the database to inspect. | @@ -113,6 +114,12 @@ The `` parameter can also inspect backups stored in AWS S3 buckets, The `--latest-backup` and `--latest-chain` options cannot be used together. ==== +[NOTE] +==== +Starting with Neo4j 2025.07, the `--show-metadata` option is deprecated and ignored. +The backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +However, if you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== [[aggregate-backup-example]] == Examples @@ -140,7 +147,7 @@ The following command lists the backup files' names along with their respective [source,shell] ---- -bin/neo4j-admin backup inspect /backups --show-metadata --empty +bin/neo4j-admin backup inspect /backups --empty ---- The `--empty` option is used to include the empty backups. @@ -163,13 +170,19 @@ Empty backups are used to record the backup history. | 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 | ---- +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== + === Listing the latest backups To list only the most recent backups performed for each database, use the `--latest-backup` option. [source,shell] ---- -bin/neo4j-admin backup inspect /backups --show-metadata --latest-backup +bin/neo4j-admin backup inspect /backups --latest-backup ---- .Example output @@ -181,6 +194,12 @@ bin/neo4j-admin backup inspect /backups --show-metadata --latest-backup | 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 | ---- +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== + === Inspecting backup chains A backup chain corresponds to a sequence of one or more backup(s) logically connected by their transaction IDs. @@ -188,7 +207,7 @@ To inspect the backup chains of a given database, use the `--latest-chain` optio [source,shell] ---- -bin/neo4j-admin backup inspect /backups --show-metadata --latest-chain --database=london +bin/neo4j-admin backup inspect /backups --latest-chain --database=london ---- .Example output @@ -206,6 +225,11 @@ The result returns a chain of size two: Those modifications are materialised by a sequence of transactions to apply. Its range is [6,6]. +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== === Inspecting a backup chain ending with a specific backup @@ -213,7 +237,7 @@ To inspect a backup chain ending with a specific backup, use the `--latest-chain [source,shell] ---- -bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --show-metadata --latest-chain +bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --latest-chain ---- .Example output @@ -229,6 +253,12 @@ bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --sho 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_. ==== +[NOTE] +==== +Starting with Neo4j 2025.07, the backup metadata is always shown by default when using the `neo4j-admin backup inspect` command. +If you are on a previous version of Neo4j, you must specify the `--show-metadata` option to see the backup metadata. +==== +