备份与恢复#

#术语

#适用范围

本文档适用于 SonarQube 9.9.5 及以上版本。

#概述

SonarQube 数据主要由两部分组成：

1. PostgreSQL 数据库数据（核心数据）
2. Elasticsearch 数据（搜索数据）

由于 Elasticsearch 数据可以从数据库重新生成，因此我们只需备份 PostgreSQL 数据库以确保数据安全。

#备份

根据您使用的 PostgreSQL 数据库类型，有两种备份方式：

• 如果使用平台提供的 PG 实例（推荐在部署 SonarQube 实例时使用）：
  • 可直接使用平台内置的数据库备份功能
  • 支持手动和定时自动备份
  • 操作简单，用户体验良好
• 如果使用自建 PG 实例，则需自行完成备份

#方法一：备份平台提供的 PostgreSQL 实例（推荐）

如果您使用的是平台提供的 PostgreSQL 实例，可以直接使用平台的备份功能：

1. 进入 Data Services 视图
2. 找到您的 PostgreSQL 实例
3. 打开 Backup and Recovery 标签页
4. 按照页面提示配置备份

平台 PG 实例支持自动备份，可在备份配置过程中开启。具体操作方法请参考平台 PG 备份与恢复文档。

完成备份配置后，您可以：

1. 点击 Create Backup 立即执行备份
2. 在备份记录中查看备份状态

#方法二：备份自建 PostgreSQL 实例

如果使用自建数据库，需要使用 pg_dump 工具进行备份。基本操作步骤如下：

pg_dump -U postgres -h 127.0.0.1 -p 5432 -d sonar -f sonar.dump

参数说明：

提示：您可以使用 crontab 实现自动定时备份。

#恢复

数据恢复需要两个步骤：

1. 恢复 PostgreSQL 数据库
2. 部署新的 SonarQube 实例并连接到恢复后的数据库

重要提示：建议新建 SonarQube 实例，而非修改原实例的数据库配置，以避免误操作导致数据丢失。

#数据库恢复

#恢复平台 PostgreSQL 实例

1. 进入 Data Services 视图
2. 找到目标 PostgreSQL 实例
3. 打开 Backup and Recovery 标签页
4. 按照 Database Recovery 向导完成恢复

注意：恢复操作会创建一个新的数据库实例。

#恢复自建 PostgreSQL 实例

自建 PG 实例需自行完成恢复操作，以下恢复命令仅供参考：

命令参数说明：

1. 创建新数据库：

   psql -U postgres -h 127.0.0.1 -p 5432 -c "CREATE DATABASE sonar_new"

2. 导入备份数据：

   psql -U postgres -h 127.0.0.1 -p 5432 -d sonar_new < sonar.dump

3. 验证恢复结果：

   psql -U postgres -h 127.0.0.1 -p 5432 -d sonar_new -c "\dt"

   如果能看到数据表列表，则恢复成功：

                     List of relations
   Schema |           Name            | Type  |  Owner
   --------+---------------------------+-------+----------
   public | active_rule_parameters    | table | postgres
   public | active_rules              | table | postgres
   ...

#部署新的 SonarQube 实例

请参考 SonarQube 部署文档创建新的 SonarQube 实例。

请注意以下要点：

1. 新部署的 SonarQube 版本必须与原实例相同版本
2. 部署时需正确配置数据库连接信息，即数据库恢复步骤中新建的数据库

有关配置数据库访问凭据的方法，请参见 SonarQube 部署文档。