SET DATA_BACKUP_DEST

描述

ALTER SYSTEM SET DATA_BACKUP_DEST 语句用于为用户租户配置备份目的端，即数据备份的备份路径。

使用限制及注意事项

• 系统租户和 Meta 租户不支持备份恢复，不需要配置备份目的端。

• 目前，OceanBase 数据库支持的备份介质为 NFS、阿里云 OSS、腾讯云 COS、AWS S3 以及兼容 S3 协议的对象存储，例如：华为 OBS、Google GCS。部分备份介质可能需要满足一些基本要求才能使用，有关各备份介质的具体要求，参见 物理备份与恢复概述 中的 备份介质要求。

权限要求

需要由 sys 租户的 root 用户（root@sys） 或各租户的管理员用户执行。其中：

• MySQL 模式的默认管理员用户为 root 用户。
• Oracle 模式的默认管理员用户为 SYS 用户。

语法

ALTER SYSTEM SET DATA_BACKUP_DEST = 'data_backup_path' [TENANT = tenant_name];

参数说明

以下是根据提供的语法模式设置 OceanBase 数据库的数据备份目的地的四个通用示例，分别针对 NFS、阿里云 OSS（Object Storage Service）、腾讯云 COS（Cloud Object Storage）和 Amazon S3（Simple Storage Service）。

参数释义示例

NFS data_backup_path 示例

ALTER SYSTEM SET DATA_BACKUP_DEST = 'nfs://your-nfs-server/your-backup-path' [TENANT = your-tenant-name];

data_backup_path 参数解释：

• nfs://your-nfs-server/your-backup-path：OceanBase 数据库可以访问的 NFS 服务器的路径，用于存储数据备份。

阿里云 OSS 示例：

ALTER SYSTEM SET DATA_BACKUP_DEST = 'oss://your-bucket-name/your-archive-path?host=oss-your-region.aliyuncs.com&access_id=your-access-id&access_key=your-access-key' [TENANT = your-tenant-name];

data_backup_path 参数解释：

• oss://your-oss-bucket-name/your-backup-path：指定阿里云 OSS 上的存储桶和备份路径，用于存储数据备份。
• host=oss-your-region.aliyuncs.com：阿里云 OSS 服务的访问域名，your-region 应替换为实际的 OSS 区域代码。
• access_id=your-access-id 和 access_key=your-access-key：用于认证的访问密钥 ID 和访问密钥。

腾讯云 COS 示例：

ALTER SYSTEM SET DATA_BACKUP_DEST = 'cos://your-bucket-name/your-archive-path?host=cos.your-region.myqcloud.com&access_id=your-access-id&access_key=your-access-key&appid=your-appid' [TENANT = your-tenant-name];

data_backup_path 参数解释：

• cos://your-cos-bucket-name/your-backup-path：指定腾讯云 COS 上的存储桶和备份路径，用于存储数据备份。
• host=cos.your-region.myqcloud.com: 腾讯云 COS 服务的访问域名，your-region 应替换为实际的区域代码。
• access_id=your-access-id 和 access_key=your-access-key：用于认证的访问 ID 和访问密钥。
• appid=your-appid：腾讯云账户的 AppID。

Amazon S3 示例：

ALTER SYSTEM SET DATA_BACKUP_DEST = 's3://your-bucket-name/your-archive-path?host=s3.your-region.amazonaws.com&access_id=your-access-id&access_key=your-access-key&s3_region=your-s3-region' [TENANT = your-tenant-name];

data_backup_path 参数解释：

• s3://your-s3-bucket-name/your-backup-path：指定 Amazon S3 上的存储桶和备份路径，用于存储数据备份。
• host=s3.your-region.amazonaws.com：Amazon S3 服务的域名，your-region 应替换为实际的 AWS 区域代码。
• access_id=your-access-id 和 access_key=your-access-key：用于 AWS 服务的访问密钥 ID 和访问密钥。
• s3_region=your-s3-region：指定 Amazon S3 存储桶所在的区域。

示例

• 系统租户

  • 系统租户为租户 mysql_tenant 配置备份目的端，备份介质为 NFS。

    obclient [oceanbase]> ALTER SYSTEM SET DATA_BACKUP_DEST = 'file:///data/nfs/backup/data' TENANT = mysql_tenant;
    

  • 系统租户为租户 mysql_tenant 配置备份目的端，备份介质为 OSS，并配置备份文件的清理模式 delete。

    obclient [oceanbase]> ALTER SYSTEM SET DATA_BACKUP_DEST = 'oss://oceanbase-test-bucket/backup/?host=xxx.aliyun-inc.com&access_id=xxx&access_key=xxx&delete_mode=delete' TENANT = mysql_tenant;
    

  • 系统租户为租户 mysql_tenant 配置备份目的端，备份介质为 COS，并配置备份文件的清理模式为 delete。

    obclient [oceanbase]> ALTER SYSTEM SET DATA_BACKUP_DEST = 'cos://oceanbase-test-bucket/backup/?host=cos.ap-xxx.myqcloud.com/&access_id=xxx&access_key=xxx&appid=xxx&delete_mode=delete' TENANT = mysql_tenant;
    

    • appid 表示腾讯云账户的 AppID，需要替换为实际的 AppID。

  • 系统租户为租户 mysql_tenant 配置备份目的端，备份介质为 S3 时，系统租户设置备份目的端并配置为 tagging 清理模式的示例如下：

    obclient [oceanbase]> ALTER SYSTEM SET DATA_BACKUP_DEST='s3://oceanbase-test-bucket/backup/data?host=s3.<region>.amazonaws.com&access_id=xxx&access_key=xxx&s3_region=xxx&delete_mode=tagging' TENANT = mysql_tenant;
    

    • s3_region 表示 S3 的存储桶所在的地域。

• 用户租户

  • 租户 mysql_tenant 为本租户配置备份目的端，备份介质为 NFS。

    obclient [oceanbase]> ALTER SYSTEM SET DATA_BACKUP_DEST = 'file:///data/nfs/backup/data';
    

  • 租户 mysql_tenant 为本租户配置备份目的端，备份介质为 OSS，并配置备份文件的清理模式为 delete。

    obclient [oceanbase]> ALTER SYSTEM SET DATA_BACKUP_DEST = 'oss://oceanbase-test-bucket/backup/?host=xxx.aliyun-inc.com&access_id=xxx&access_key=xxx&delete_mode=delete';
    

  • 租户 oracle_tenant 为本租户配置备份目的端，备份介质为 COS，并配置备份文件的清理模式为 delete。

    obclient [SYS]> ALTER SYSTEM SET DATA_BACKUP_DEST = 'cos://oceanbase-test-bucket/backup/?host=cos.ap-xxx.myqcloud.com/&access_id=xxx&access_key=xxx&appid=xxx&delete_mode=delete';
    

    • appid 表示腾讯云账户的 AppID，需要替换为实际的 AppID。

  • 租户 mysql_tenant 为本租户配置备份目的端，备份介质为 S3 时，并设置备份目的端并配置为 tagging 清理模式的示例如下：

    obclient [oceanbase]> ALTER SYSTEM SET DATA_BACKUP_DEST='s3://oceanbase-test-bucket/backup/data?host=s3.<region>.amazonaws.com&access_id=xxx&access_key=xxx&s3_region=xxx&delete_mode=tagging';
    

    • s3_region 表示 S3 的存储桶所在的地域。

相关文档

• BACKUP KEY

• BACKUP

• 备份前准备