BACKUP | OceanBase 文档中心

BACKUP

更新时间：2026-06-11 09:37:16

描述

该语句用来触发备份。有关 OceanBase 数据库的备份与恢复相关的操作，请参见《OceanBase 数据库管理员指南》中的 备份恢复管理 章节。

该语句仅支持在 sys 租户执行。

语法

alter_system_backup_stmt:
    ALTER SYSTEM backup_action;

backup_action:
      SET BACKUP_DEST = 'backup_url' 
    | SET BACKUP_BACKUP_DEST = 'backup_backup_url'
    | ARCHIVELOG | NOARCHIVELOG
    | BACKUP DATABASE | BACKUP ARCHIVELOG
    | BACKUP BACKUPPIECE ALL NOT BACKED UP n TIMES [tenant_identifier] [BACKUP_BACKUP_DEST='url']
    | BACKUP BACKUPPIECE [= n] [tenant_identifier] [BACKUP_BACKUP_DEST='url'] [WITH ACTIVE BACKUPPIECE]
    | BACKUP BACKUPSET ALL NOT BACKED UP n TIMES [tenant_identifier] [BACKUP_BACKUP_DEST='url']
    | BACKUP BACKUPSET = n [tenant_identifier] [BACKUP_BACKUP_DEST='url']
    | CANCEL BACKUP [BACKUPSET | BACKUPPIECE]
    | {START | STOP} BACKUP ARCHIVELOG
    | BACKUP TENANT tenant_name_list TO backup_destination
    | CHANGE EXTERNAL_STORAGE_DEST PATH='backup_path' SET    ACCESS_INFO='access_id=your_access_id&access_key=your_access_key'
   

tenant_identifier:
     TENANT_ID = tenant_id | TENANT_NAME = 'tenant_name'

tenant_name_list：
      tenant_name [, tenant_name ...]

参数与关键字解释

参数	描述
BACKUP_DEST	指定备份的路径，目前支持 OSS 和 FILE 两种，具体格式参考示例。
BACKUP_BACKUP_DEST	指定备份备份的目的路径，支持 OSS 和 FILE 两种。
ARCHIVELOG \| NOARCHIVELOG	开启或关闭日志备份。说明为了减少日志备份发起的耗时，建议在开启日志备份前进行一次转储，待转储完成后再备份。这是因为日志备份的起始位点是最近一次转储位点，转储以后可以减少日志备份启动的时间。
BACKUP DATABASE	触发基线备份（只支持集群级别）。
BACKUP BACKUPPIECE	备份备份的日志。 `ALL NOT BACKED UP n TIMES` 表示备份副本数不足 n 个的日志备份。 `[= n]` 表示备份指定 BACKUPPIECE ID 的日志备份，如果指定 `WITH ACTIVE BACKUPPIECE`，会同时将 ACTIVE 的备份一起备份。
BACKUP BACKUPSET	备份备份的数据。 `ALL NOT BACKED UP n TIMES` 表示备份副本数不足 n 个的数据备份。 `= n` 表示备份指定 BACKUPSET ID` 的数据备份。
CANCEL BACKUP	取消当前基线备份。
CANCEL BACKUP {BACKUPSET \| BACKUPPIECE}	取消当前备份的备份。 `BACKUPSET` 表示取消正在备份的备份数据。 `BACKUPPIECE` 表示取消正在备份的备份日志。说明停止数据备份任务后，如果再次发起数据备份，系统会重新开始备份。关于 `BACKUP BACKUPPIECE` 的用法，请参见《OceanBase 数据库管理员指南》中的执行备份备份章节的备份多目录的备份小节。
{START \| STOP} BACKUP ARCHIVELOG	启动或停止自动备份备份日志。说明不建议使用 `BACKUP ARCHIVELOG` 功能，推荐使用 `BACKUP BACKUPPIECE` 功能。关于 `BACKUP ARCHIVELOG` 的用法，请参见《OceanBase 数据库管理员指南》中的执行备份备份章节的不切 Piece 模式下日志的备份备份小节。
EXTERNAL_STORAGE_DEST	表示外部存储目的端，用在修改备份目的端的授权信息的命令中。说明此命令仅适用于对象存储 OSS，不支持备份介质为 NFS。此命令不用于配置备份目的端，而是修改备份目的端的参数信息，必须先通过 `SET` 命令成功设置有效的 `backup_dest` 或 `backup_backup_dest` 后，再使用此命令。设置的 `backup_dest` 必须有操作权限，否则命令执行会报错。此命令仅允许对当前配置项 `backup_dest` 和 `backup_backup_dest` 对应的目的端进行修改。在数据备份任务正在执行时，不允许修改 `backup_dest` 的 `access_id` 或者 `access_key`。在备份备份任务正在执行时，不允许修改`backup_backup_dest` 的 `access_id` 或者 `access_key`，但允许修改 backup_des t的 `access_id` 或者 `access_key`。
PATH	指用于指定唯一目的端的信息，包括备份路径和 Endpoint 信息，两者可以确定唯一目的端。说明 `PATH` 不支持 `&` 符号，如果备份路径中含有 `&` 符号，则不可使用此命令来修改目的端授权信息的 `access_id` 和 `access_key`。 `PATH` 只支持对象存储类型的设置，标准格式的示例为 `oss://xxx?host=xxx`，如果 `PATH` 包含了其他参数将发生报错。
ACCESS_INFO	用于设置变更的 `access_id` 和 `access_key` 值，且仅允许设置 `access_id` 和 `access_key` 的值，且 `access_id` 和 `access_key` 的设置必须匹配，不允许仅设置 `access_id` 或者仅设置 `access_key`。
tenant_id	指定租户 ID。
tenant_name	指定租户名称。
tenant_name_list	表示需要备份的租户列表。目前支持最多 256 个租户名称。
backup_destination	表示备份文件的目的地。目前支持 NFS 和 OSS 两种目的地。

示例

设置备份的路径。

obclient> ALTER SYSTEM SET backup_dest='oss://antsys-oceanbasebackup/backup_dir?host=xxx&access_id=xxx&access_key=xxx';
obclient> ALTER SYSTEM SET backup_dest='file:///data/nfs/physical_backup_dir';

备份备份的日志。

obclient> ALTER SYSTEM BACKUP BACKUPPIECE ALL NOT BACKED UP 2 TIMES BACKUP_BACKUP_DEST= 'file:///ob_backup_backup/ob_cluster_1_backup_piece_20200125';
obclient> ALTER SYSTEM BACKUP BACKUPPIECE 1 TENANT_NAME tenant_1 BACKUP_BACKUP_DEST= 'file:///ob_backup_backup/ob_cluster_1_backup_piece_20200225';

租户级别备份。

obclient> ALTER SYSTEM BACKUP TENANT tenant1,tenant2 TO "file:///ob_backup/";

在日志备份任务执行过程中支持修改备份目的端的授权信息 access_id 和 access_key。

obclient> ALTER SYSTEM CHANGE EXTERNAL_STORAGE_DEST PATH='oss://oceanbase-test-bucket/backup/?host=xxx.aliyun-inc.com' SET ACCESS_INFO='access_id=***&access_key=***';