检查备份文件的元数据

您可以使用 neo4j-admin backup inspect 命令检查数据库备份文件的元数据。

命令

inspect 命令列出存储在备份文件头部中的元数据。这些元数据主要定义了备份如何连接以形成备份链(backup chains)。备份链是一个或多个逻辑连接的备份序列。该序列的顺序保证了在回放时(参见恢复聚合),存储和事务数据能以一致的方式被使用。

元数据包含以下信息:

  • Database(数据库):备份所包含的数据库片段的名称。

  • Database ID(数据库 ID):用于区分数据库(即使名称相同)的唯一标识符。

  • Time(时间):执行备份的时间。

  • Full(全量备份):指示这是否是全量备份(即包含存储文件的初始备份)或增量备份(即仅包含应用于存储文件的后续事务的后续备份)。

  • Compressed(压缩):指示备份文件内的备份数据是否已压缩。

  • Lowest transaction ID(最低事务 ID):当备份为全量备份时,该值始终为 1;当备份为增量备份时,该值对应于备份起始的第一个事务 ID。

  • Highest transaction ID(最高事务 ID):同样,该值指示备份文件中存储的最后一个事务 ID。

  • 引入于 2025.06 Recovered(已恢复):显示数据库备份是否已恢复。

语法

neo4j-admin backup inspect [-h] [--empty] [--expand-commands] [--latest-backup] [--latest-chain]
                           [--verbose] [--additional-config=<file>] [--database=<database>] [--format=<value>]
                           <backup-path>

从 Neo4j 2025.07 开始,在使用 neo4j-admin backup inspect 命令时默认总是显示备份元数据。如果您使用的是之前版本的 Neo4j,则必须指定 --show-metadata 选项才能查看备份元数据。

描述

读取备份元数据的命令。

参数

表 1. neo4j-admin backup inspect 参数
参数 描述

<backup-path>

表示存储备份的目录或要检查的单个备份的路径。

<backup-path> 参数还可以检查存储在 AWS S3 存储桶、Google Cloud 存储桶和 Azure 存储桶中的备份。

选项

表 2. neo4j-admin backup inspect 选项
选项 描述 默认

--additional-config=<file>[1]

包含额外配置的配置文件。

--expand-commands

允许在配置值评估中进行命令扩展。

-h, --help

显示此帮助消息并退出。

--latest-backup

仅显示最新的备份。

false

--latest-chain

列出以最新下载备份结尾的完整备份链。

false

--database=<database>

要检查的数据库名称。

--format=<value>

命令输出的格式。可选值为:'JSON, TABULAR'。

TABULAR

--empty

包含空备份。

false

--verbose

启用详细输出。

1. 有关详细信息,请参阅 Neo4j Admin 和 Neo4j CLI → 配置

--latest-backup--latest-chain 选项不能同时使用。

从 Neo4j 2025.07 开始,--show-metadata 选项已被弃用并会被忽略。在使用 neo4j-admin backup inspect 命令时,默认总是显示备份元数据。然而,如果您使用的是之前版本的 Neo4j,则必须指定 --show-metadata 选项才能查看备份元数据。

示例

假设文件夹 /backups 包含一组数据库备份

/backups
├── london-2024-10-07T16-03-51.backup
├── london-2024-10-07T16-04-05.backup
├── malmo-2024-10-07T16-00-07.backup
├── malmo-2024-10-07T16-00-19.backup
├── malmo-2024-10-07T16-00-34.backup
├── malmo-2024-10-07T16-00-44.backup
├── malmo-2024-10-07T16-00-50.backup
├── malmo-2024-10-07T16-01-08.backup
├── malmo-2024-10-07T16-01-24.backup
└── neo4j-2024-10-07T16-05-37.backup

列出备份文件的元数据

以下命令列出备份文件的名称及其各自的元数据

bin/neo4j-admin backup inspect /backups --empty

--empty 选项用于包含空备份。当数据库进行了备份但没有新数据时,会创建空备份。空备份用于记录备份历史。

输出示例
|                                              FILE | DATABASE |                          DATABASE ID |          TIME (UTC) |  FULL | COMPRESSED | LOWEST TX | HIGHEST TX | RECOVERED |
|  file:///backups/neo4j-2024-10-07T16-05-37.backup |    neo4j | 7dcb1d0c-4374-4476-b8ae-d3c3f124683f | 2024-10-07T16:05:37 |  true |       true |         1 |          3 |      true |
|  file:///backups/malmo-2024-10-07T16-01-24.backup |    malmo | 62d1820c-3ac6-4b15-a0b3-bf7e7becc8d0 | 2024-10-07T16:01:24 |  true |       true |         1 |          8 |      true |
|  file:///backups/malmo-2024-10-07T16-01-08.backup |    malmo | 62d1820c-3ac6-4b15-a0b3-bf7e7becc8d0 | 2024-10-07T16:01:08 |  true |       true |         1 |          7 |     false |
|  file:///backups/malmo-2024-10-07T16-00-50.backup |    malmo | 62d1820c-3ac6-4b15-a0b3-bf7e7becc8d0 | 2024-10-07T16:00:50 | false |       true |         0 |          0 |     false |
|  file:///backups/malmo-2024-10-07T16-00-44.backup |    malmo | 62d1820c-3ac6-4b15-a0b3-bf7e7becc8d0 | 2024-10-07T16:00:44 | false |       true |         7 |          7 |     false |
|  file:///backups/malmo-2024-10-07T16-00-34.backup |    malmo | 62d1820c-3ac6-4b15-a0b3-bf7e7becc8d0 | 2024-10-07T16:00:34 | false |       true |         6 |          6 |     false |
|  file:///backups/malmo-2024-10-07T16-00-19.backup |    malmo | 62d1820c-3ac6-4b15-a0b3-bf7e7becc8d0 | 2024-10-07T16:00:19 | false |       true |         0 |          0 |     false |
|  file:///backups/malmo-2024-10-07T16-00-07.backup |    malmo | 62d1820c-3ac6-4b15-a0b3-bf7e7becc8d0 | 2024-10-07T16:00:07 |  true |       true |         1 |          5 |      true |
| 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 |
| 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 |

从 Neo4j 2025.07 开始,在使用 neo4j-admin backup inspect 命令时默认总是显示备份元数据。如果您使用的是之前版本的 Neo4j,则必须指定 --show-metadata 选项才能查看备份元数据。

列出最新的备份

要仅列出每个数据库执行的最新备份,请使用 --latest-backup 选项。

bin/neo4j-admin backup inspect /backups --latest-backup
输出示例
|                                              FILE | DATABASE |                          DATABASE ID |          TIME (UTC) |  FULL | COMPRESSED | LOWEST TX | HIGHEST TX | RECOVERED |
|  file:///backups/neo4j-2024-10-07T16-05-37.backup |    neo4j | 7dcb1d0c-4374-4476-b8ae-d3c3f124683f | 2024-10-07T16:05:37 |  true |       true |         1 |          3 |      true |
|  file:///backups/malmo-2024-10-07T16-01-24.backup |    malmo | 62d1820c-3ac6-4b15-a0b3-bf7e7becc8d0 | 2024-10-07T16:01:24 |  true |       true |         1 |          8 |      true |
| 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 |

从 Neo4j 2025.07 开始,在使用 neo4j-admin backup inspect 命令时默认总是显示备份元数据。如果您使用的是之前版本的 Neo4j,则必须指定 --show-metadata 选项才能查看备份元数据。

检查备份链

备份链对应于通过事务 ID 逻辑连接的一个或多个备份序列。要检查给定数据库的备份链,请使用 --latest-chain 选项,并配合 --database 选项指定您要检查其备份链的数据库。

bin/neo4j-admin backup inspect /backups --latest-chain --database=london
输出示例
|                                              FILE | DATABASE |                          DATABASE ID |          TIME (UTC) |  FULL | COMPRESSED | LOWEST TX | HIGHEST TX | RECOVERED |
| 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 |
| 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 |

结果返回一个大小为二的链

  • 第一个备份是一个全量备份,包含事务范围 [1,5] 内的存储文件。

  • 第二个备份是一个增量备份,仅包含对存储文件的后续修改。这些修改由一系列要应用的事务实现。其范围是 [6,6]。

从 Neo4j 2025.07 开始,在使用 neo4j-admin backup inspect 命令时默认总是显示备份元数据。如果您使用的是之前版本的 Neo4j,则必须指定 --show-metadata 选项才能查看备份元数据。

检查以特定备份结尾的备份链

要检查以特定备份结尾的备份链,请按如下方式使用 --latest-chain 选项

bin/neo4j-admin backup inspect /backups/london-2024-10-07T16-04-05.backup --latest-chain
输出示例
|                                              FILE | DATABASE |                          DATABASE ID |          TIME (UTC) |  FULL | COMPRESSED | LOWEST TX | HIGHEST TX | RECOVERED |
| 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 |
| 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 |

在这种情况下,--database 选项是不必要的,因为数据库标识符是存储在备份文件 london-2024-10-07T16-04-05.backup 头部元数据中的一部分。

从 Neo4j 2025.07 开始,在使用 neo4j-admin backup inspect 命令时默认总是显示备份元数据。如果您使用的是之前版本的 Neo4j,则必须指定 --show-metadata 选项才能查看备份元数据。