备份配置项

OceanBase 数据库支持备份租户级配置项和集群级配置项。通过对配置项的备份，为后续快速恢复集群和租户状态时提供配置参考。

注意事项

本文中备份的集群级配置项和租户级配置项仅用于为用户提供配置参考，在进行物理恢复时，不会恢复到集群和租户中。

备份集群级配置项

由于数据备份并未对集群级配置项进行备份，如果要备份集群级配置项，则需要手动执行命令将原集群级配置项备份到指定路径（仅备份非默认设置的集群范围的配置项）。

使用限制及注意事项

• 仅 sys 租户可以备份集群级配置项，用户租户不支持备份集群级配置项。

• 在备份集群级配置项时，对于 all_server_list、rootservice_list 和 debug_sync_timeout 等配置项，无论其值是否为默认值，均不会备份。

操作步骤

1. 使用 root 用户登录集群的 sys 租户。

2. 执行以下 SQL 语句，备份集群级配置项。

   SQL 语句如下：

   ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 'parameters_backup_path';
   

   其中，parameters_backup_path 为集群级配置项备份文件的目标路径，需要用户自行指定。其路径要求与数据备份的备份目的端路径要求一致。有关数据备份的备份目的端要求，参见 备份前准备。

   相关示例如下：

   阿里云 OSS

   NFS

   AWS S3

   兼容 S3 协议的对象存储

   将集群级配置项备份至 oss://oceanbase-test-bucket/backup/cluster_parameters?host=***.aliyun-inc.com&access_id=***&access_key=*** 目录下：

   obclient> ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 'oss://oceanbase-test-bucket/backup/cluster_parameters?host=***.aliyun-inc.com&access_id=***&access_key=***';
   

   将集群级配置项备份至 file:///data/nfs/backup/cluster_parameters 目录下：

   obclient> ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 'file:///data/nfs/backup/cluster_parameters';
   

   将集群级配置项备份至 s3://oceanbase-test-bucket/backup/data/cluster_parameters?host=s3.***.amazonaws.com&access_id=****&access_key=****&s3_region=**** 目录下：

   obclient> ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 's3://oceanbase-test-bucket/backup/data/cluster_parameters?host=s3.***.amazonaws.com&access_id=****&access_key=****&s3_region=****';
   

   • 将集群级配置项备份至华为 OBS 的 s3://oceanbase-test-bucket/backup/data/cluster_parameters?host=obs.****.myhuaweicloud.com&access_id=****&access_key=**** 目录下：

     obclient> ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 's3://oceanbase-test-bucket/backup/data/cluster_parameters?host=obs.****.myhuaweicloud.com&access_id=****&access_key=****';
     

   • 将集群级配置项备份至 GCS 的 s3://oceanbase-test-bucket/backup/data/cluster_parameters?host=https://storage.googleapis.com&access_id=****&access_key=**** 目录下：

     obclient> ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 's3://oceanbase-test-bucket/backup/data/cluster_parameters?host=https://storage.googleapis.com&access_id=****&access_key=****';
     

   • 将集群级配置项备份至 COS 的 s3://oceanbase-test-bucket/backup/data/cluster_parameters?host=cos.ap-xxxx.myqcloud.com&access_id=***&access_key=*** 目录下：

     obclient> ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 's3://oceanbase-test-bucket/backup/data/cluster_parameters?host=cos.ap-xxxx.myqcloud.com&access_id=***&access_key=***';
     

备份租户级配置项

对于租户级配置项，在进行 全量数据备份 或 增量数据备份 时，系统已将租户级配置项（非默认设置的租户范围的配置项）以及租户的资源配置等信息作为租户数据备份的一部分，一起备份到备份目的端，无需再执行额外的备份操作。

后续操作

备份成功后，用户可以在之前指定的备份路径下，获取租户级和集群级配置项备份文件，租户级配置项和集群级配置项备份后的详细目录结构，参见 物理备份与恢复概述。

获取配置项的备份文件后，可进一步使用 ob_admin 工具的 dump_backup 命令进行解析获取配置信息，详细解析说明及示例参见 dump_backup。

相关文档

• 物理备份与恢复概述

• 备份前准备