恢复数据库转储

neo4j-admin database load 命令可用于从使用 neo4j-admin database dump 命令创建的归档文件中加载数据库。
从 Neo4j 5.20 开始,neo4j-admin database load 命令还支持加载 Neo4j Enterprise 的 neo4j-admin database backup 命令创建的完整备份文件。

如果要替换现有数据库,则必须在运行命令之前将其关闭,并使用 --overwrite-destination 选项。
企业版 如果不替换现有数据库,则必须在加载操作完成后创建数据库(对 system 数据库使用 CREATE DATABASE)。

该命令可以在在线或离线 Neo4j DBMS 上运行,并且必须以 neo4j 用户身份执行,以确保适当的文件权限。

更改数据捕获**不会**捕获使用 neo4j-admin database load 导致的任何数据更改。有关更多信息,请参阅 更改数据捕获 → 关键注意事项

语法

neo4j-admin database load [-h] [--expand-commands] [--info] [--verbose] [--overwrite-destination[=true|false]]
                          [--additional-config=<file>] [--from-path=<path> | --from-stdin] <database>

描述

从归档文件中加载数据库。<archive-path> 必须是包含一个或多个归档文件的目录。归档文件可以是使用 dump 命令创建的数据库转储,也可以是 Neo4j Enterprise 的 backup 命令创建的完整备份文件。如果既未提供 --from-path 也未提供 --from-stdin,则将搜索 server.directories.dumps.root 设置以查找归档文件。可以通过指定 --overwrite-destination 替换现有数据库。无法替换在正在运行的 Neo4j 服务器中挂载的数据库。如果指定了 --info,则不会加载数据库,而是打印有关归档文件的信息(即文件数量、字节数和加载文件格式)。

参数

表 1. neo4j-admin database load 参数
参数 描述

<database>

要加载的数据库名称。可以包含 * 和 ? 用于通配符匹配。请注意,* 和 ? 在某些 shell 中具有特殊含义,可能需要转义或使用引号。

选项

表 2. neo4j-admin database load 选项
选项 描述 默认值

--additional-config=<file>

包含其他配置的配置文件。

--expand-commands

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

--from-path=<path>

包含归档文件的目录的路径。可以使用适当的 URI 作为路径,从 AWS S3 存储桶、Google Cloud 存储桶和 Azure 存储桶加载数据库。

--from-stdin

从标准输入读取归档文件。

-h, --help

显示此帮助消息并退出。

--info

打印有关归档文件元数据信息,而不是加载包含的数据库。

--overwrite-destination[=true|false]

是否应替换现有数据库。

false

--verbose

启用详细输出。

--from-path=<path> 选项还可以从 AWS S3 存储桶(从 Neo4j 5.19 开始)、Google Cloud 存储桶(从 Neo4j 5.21 开始)和 Azure 存储桶(从 Neo4j 5.24 开始)加载数据库。有关更多信息,请参阅 从云存储加载转储

示例

以下是如何加载数据库转储(database.dump)的示例,该转储是在 备份离线数据库 部分中创建的,使用 neo4j-admin database load 命令。替换现有数据库时,必须在运行命令之前将其关闭。由于要替换现有数据库,因此需要 --overwrite-destination 选项。

如果未替换现有数据库,则必须在加载操作完成后创建数据库(对 system 数据库使用 CREATE DATABASE)。

该命令会在名为 <database>.dump 的文件中查找,其中 <database> 是命令中指定的数据库。
从 Neo4j 5.20 开始,该命令还会查找完整备份文件。

在使用 load 命令为集群播种时,如果数据库的先前版本存在,则必须先将其删除(使用 DROP DATABASE)。或者,您可以停止 Neo4j 实例并使用 neo4j-admin server unbind 将其从集群中解除绑定以删除其集群状态数据。如果在加载转储之前未执行 DROP 或解除绑定操作,则该数据库的存储文件将与其集群状态不同步,可能会导致逻辑损坏。有关更多信息,请参阅 播种集群

neo4j-admin database load 不能应用于 复合数据库。它必须直接在与该复合数据库关联的数据库上运行。

从本地目录加载转储

可以使用以下命令从本地目录加载转储

bin/neo4j-admin database load --from-path=/full-path/data/dumps neo4j --overwrite-destination=true

从 Neo4j 5.20 开始,可以使用相同的命令从其完整备份文件中加载数据库

bin/neo4j-admin database load --from-path=/full-path/to/backups neo4j --overwrite-destination=true

以下示例显示了如何为 load 命令指定特定归档文件。

cat foo.dump | neo4j-admin database load --from-stdin mydatabase

从云存储加载转储

以下示例显示了如何使用 --from-path 选项加载位于云存储桶中的数据库转储。

Neo4j 使用 AWS SDK v2 通过 AWS URL 调用 AWS 上的 API。或者,您可以覆盖端点,以便 AWS SDK 可以使用系统变量 aws.endpointUrls3aws.endpointUrlS3aws.endpointUrl 或环境变量 AWS_ENDPOINT_URL_S3AWS_ENDPOINT_URL 与其他存储系统(如 Ceph、Minio 或 LocalStack)通信。

  1. 按照 AWS 官方文档中的说明安装 AWS CLI — 安装 AWS CLI 版本 2

  2. 使用 AWS CLI 创建一个 S3 存储桶和一个目录以存储备份文件

    aws s3 mb --region=us-east-1 s3://myBucket
    aws s3api put-object --bucket myBucket --key myDirectory/

    有关如何创建存储桶和使用 AWS CLI 的更多信息,请参阅 AWS 官方文档 — 使用 AWS CLI 使用 Amazon S3使用 AWS CLI 使用高级 (s3) 命令

  3. 通过运行以下命令验证 ~/.aws/config 文件是否正确

    cat ~/.aws/config

    输出应如下所示

    [default]
    region=us-east-1
  4. 通过在 ~/.aws/credentials 文件中设置 aws_access_key_idaws_secret_access_key 以及(如果需要)使用存储桶策略来配置对 AWS S3 存储桶的访问权限。例如

    1. 使用 aws configure set aws_access_key_id aws_secret_access_key 命令设置来自 AWS 的 IAM 凭据,并验证 ~/.aws/credentials 是否正确

      cat ~/.aws/credentials

      输出应如下所示

      [default]
      aws_access_key_id=this.is.secret
      aws_secret_access_key=this.is.super.secret
    2. 此外,您可以使用基于资源的策略来授予对 S3 存储桶及其中的对象的访问权限。创建具有以下内容的策略文档并将其附加到存储桶。请注意,两个资源条目对于能够下载和上传文件都非常重要。

      {
          "Version": "2012-10-17",
          "Id": "Neo4jBackupAggregatePolicy",
          "Statement": [
              {
                  "Sid": "Neo4jBackupAggregateStatement",
                  "Effect": "Allow",
                  "Action": [
                      "s3:ListBucket",
                      "s3:GetObject",
                      "s3:PutObject",
                      "s3:DeleteObject"
                  ],
                  "Resource": [
                      "arn:aws:s3:::myBucket/*",
                      "arn:aws:s3:::myBucket"
                  ]
              }
          ]
      }
  5. 运行 neo4j-admin database load 命令以从 AWS S3 存储加载转储。此示例假设存储桶的 myBucket/myDirectory 文件夹中存在转储文件。

    bin/neo4j-admin database load mydatabase --from-path=s3://myBucket/myDirectory/ --overwrite-destination=true
  1. 确保您拥有 Google 帐户并在 Google Cloud Platform (GCP) 中创建了一个项目。

    1. 按照 Google 官方文档中的说明安装 gcloud CLI — 安装 gcloud CLI

    2. 使用 Google 官方文档创建服务帐户和服务帐户密钥 — 创建服务帐户创建和管理服务帐户密钥

    3. 下载服务帐户的 JSON 密钥文件。

    4. GOOGLE_APPLICATION_CREDENTIALSGOOGLE_CLOUD_PROJECT 环境变量分别设置为 JSON 密钥文件的路径和项目 ID

      export GOOGLE_APPLICATION_CREDENTIALS="/path/to/keyfile.json"
      export GOOGLE_CLOUD_PROJECT=YOUR_PROJECT_ID
    5. 使用您创建的服务帐户的电子邮件地址、JSON 密钥文件的路径和项目 ID 对 gcloud CLI 进行身份验证

      gcloud auth activate-service-account service-account@example.com --key-file=$GOOGLE_APPLICATION_CREDENTIALS --project=$GOOGLE_CLOUD_PROJECT

      有关更多信息,请参阅 Google 官方文档 — gcloud auth activate-service-account

    6. 使用 Google 官方文档在 Google Cloud Storage 中创建存储桶 — 创建存储桶

    7. 通过运行以下命令验证存储桶是否已创建

      gcloud storage ls

      输出应列出已创建的存储桶。

  2. 运行 neo4j-admin database load 命令以从 Google 存储桶加载转储。此示例假设存储桶的 myBucket/myDirectory 文件夹中存在转储文件。

    bin/neo4j-admin database load mydatabase --from-path=gs://myBucket/myDirectory/ --overwrite-destination=true
  1. 确保您拥有 Azure 帐户、Azure 存储帐户和 Blob 容器。

    1. 您可以使用 Azure 门户创建存储帐户。
      有关更多信息,请参阅 Azure 官方文档 创建存储帐户

    2. 在 Azure 门户中创建 Blob 容器。
      有关更多信息,请参阅 Azure 官方文档 快速入门:使用 Azure 门户上传、下载和列出 Blob

  2. 按照 Azure 官方文档中的说明安装 Azure CLI — Azure 官方文档

  3. 使用默认 Azure 凭据对 neo4j 或 neo4j-admin 进程进行 Azure 身份验证。
    有关更多信息,请参阅 Azure 官方文档 默认 Azure 凭据

    az login

    然后,您应该准备好使用 neo4j 或 neo4j-admin 中的 Azure URL。

  4. 要验证您是否可以使用登录凭据访问容器,请运行以下命令

    # Upload a file:
    az storage blob upload --file someLocalFile  --account-name accountName - --container someContainer --name remoteFileName  --auth-mode login
    
    # Download the file
    az storage blob download  --account-name accountName --container someContainer --name remoteFileName --file downloadedFile --auth-mode login
    
    # List container files
    az storage blob list  --account-name someContainer --container someContainer  --auth-mode login
  5. 运行 neo4j-admin database load 命令以从 Azure Blob 存储容器加载转储。此示例假设 Azure 帐户的 myStorageAccount/myContainer/myDirectory 文件夹中存在转储文件。

    bin/neo4j-admin database load mydatabase --from-path=azb://myStorageAccount/myContainer/myDirectory --overwrite-destination=true