---
title: "SET LOG_ARCHIVE_DEST - OceanBase 数据库 V4.3.1 | OceanBase 文档中心"
description: SET LOG_ARCHIVE_DEST 描述 ALTER SYSTEM SET LOG_ARCHIVE_DEST 语句用于为用户租户配置归档目的端。归档目的端的配置主要包括 LOCATION 、 BINDING 以及 PIECE_SWITCH_INTERVAL 等参数。 使用限制及注意事项 系统租户和 Meta 租…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*P8CuR4UJ_FkAAAAAAAAAAAAADiGDAQ/original) OceanBase 数据库分布式版 - V 4.3.1

# SET LOG_ARCHIVE_DEST

更新时间：2026-04-10 11:58:01

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.3.1/zh-CN/700.reference/500.sql-reference/100.sql-syntax/100.system-tenants/200.alter-system/150.set-log-archive-dest.md)  

## 描述

`ALTER SYSTEM SET LOG_ARCHIVE_DEST` 语句用于为用户租户配置归档目的端。归档目的端的配置主要包括 `LOCATION`、`BINDING` 以及 `PIECE_SWITCH_INTERVAL`等参数。

## 使用限制及注意事项

- 系统租户和 Meta 租户不支持备份恢复，不需要配置归档目的端。
 - 目前 OceanBase 数据库支持的备份介质为 NFS、阿里云 OSS、腾讯云 COS、AWS S3 以及兼容 S3 协议的对象存储，例如：华为 OBS、Google GCS。部分备份介质可能需要满足一些基本要求才能使用，有关各备份介质的具体要求，参见 [物理备份与恢复概述](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000818529) 中的 **备份介质要求**。
 - 配置 `LOCATION`、`BINDING` 以及 `PIECE_SWITCH_INTERVAL` 等时，各参数项之间通过空格分隔，同时设置各参数值的等号（=）前后不能有空格。
 - 归档目的端配置成功后，不支持增量配置，即需要在每次执行 `ALTER SYSTEM SET LOG_ARCHIVE_DEST` 语句时均指定所有参数的值，否则未指定的参数将使用默认值。

## 权限要求

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

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

## 语法

```shell
ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=archive_path [BINDING=archive_mode] [PIECE_SWITCH_INTERVAL=piece_switch_interval]' [TENANT = tenant_name];

```

## 参数说明

| 参数 | 描述 |
| --- | --- |
| archive_path | 指定归档路径。目前 OceanBase 数据库支持的归档介质为 NFS、阿里云 OSS、腾讯云 COS 以及 AWS 的 S3。具体 `archive_path` 示例参见下文。   使用 OSS、COS 或 S3 作为归档介质时，支持在归档路径后通过 `delete_mode` 参数来配置归档文件的清理模式，`delete_mode` 参数与归档路径之间通过 `&` 符号连接。`delete_mode` 参数当前支持以下两种取值：   - `delete`：该模式下，对于满足清理要求的归档文件，系统会直接将其删除。 - `tagging`：该模式下，对于满足清理要求的归档文件，系统会为其设置 Tag，归档文件仍然保留。 |
| archive_mode | 配置归档和业务的优先模式，可选。目前支持 Optional 模式和 Mandatory 模式。如果不设置，默认为 Optional 模式。   - Optional 模式：表示以用户业务优先。在该模式下，当归档（日志归档）速度跟不上日志生成的速度时，日志有可能来不及归档就被回收了，导致发生断流。 - Mandatory 模式：表示以归档优先。在该模式下，如果归档跟不上用户数据的写入，可能会导致用户无法写入。 |
| piece_switch_interval | 配置 Piece 的切换周期，可选，取值范围为 [1d, 7d]。如果不设置，默认为 `1d`。有关 Piece 的详细介绍，请参见 [日志归档概述](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000818800)。 |
| tenant_name | 系统租户指定待配置归档目的端的租户名。   #### 注意    仅系统租户在执行此命令时需要通过 `TENANT tenant_name` 子句指定待操作的租户，用户租户只能对本租户执行此命令，故不需要指定该子句。 |

### 参数释义示例

#### NFS 归档 archive_path 示例

```sql
ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=nfs://your-nfs-server-path/your-archive-path [BINDING=your-binding-mode] [PIECE_SWITCH_INTERVAL=your-interval]' [TENANT = your-tenant-name];

```

`archive_path` 参数解释：

- `LOCATION=nfs://your-nfs-server-path/your-archive-path`：指定 NFS 服务器路径和归档路径。

#### 阿里云 OSS 归档 archive_path 示例

```sql
ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=oss://your-bucket-name/your-archive-path?host=oss-your-region.aliyuncs.com&access_id=your-access-id&access_key=your-access-key [BINDING=your-binding-mode] [PIECE_SWITCH_INTERVAL=your-interval]' [TENANT = your-tenant-name];

```

#### 注意

使用对象存储作为归档介质时，对象存储路径的各项参数由 `&` 符号进行分隔，请确保您输入的参数值中仅包含英文字母大小写、数字、`/-_$+=` 以及通配符。如果您输入了上述以外的其他字符，可能会导致设置失败。

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

#### 腾讯云 COS archive_path 示例

```sql
ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=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 [BINDING=your-binding-mode] [PIECE_SWITCH_INTERVAL=your-interval]' [TENANT = your-tenant-name];

```

- `LOCATION=cos://your-bucket-name/your-archive-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 archive_path 示例

```sql
ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=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 [BINDING=your-binding-mode] [PIECE_SWITCH_INTERVAL=your-interval]' [TENANT = your-tenant-name];

```

- `LOCATION=s3://your-bucket-name/your-archive-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，采用用户业务优先模式，且每隔一天切分一个 Piece。

      ```shell
      obclient [oceanbase]> ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=file:///data/nfs/backup/archive BINDING=Optional PIECE_SWITCH_INTERVAL=1d' TENANT = mysql_tenant;

      ```
     - 系统租户为租户 `mysql_tenant` 配置归档目的端，归档介质为 OSS，归档文件的清理模式为 `tagging`。

      ```shell
      obclient [oceanbase]> ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=oss://oceanbase-test-bucket/backup/archive?host=xxx.aliyun-inc.com&access_id=xxx&access_key=xxx&delete_mode=tagging' TENANT = mysql_tenant;

      ```
     - 系统租户为租户 `mysql_tenant` 配置归档目的端，归档介质为 COS，归档文件的清理模式为 `delete`，采用归档优先模式，并且每隔 2 天切分一个 Piece。

      ```shell
      obclient [oceanbase]> ALTER SYSTEM SET LOG_ARCHIVE_DEST = 'LOCATION=cos://oceanbase-test-bucket/archive?host=cos.ap-xxx.myqcloud.com&access_id=xxx&access_key=xxx&appid=xxx&delete_mode=delete BINDING=Mandatory PIECE_SWITCH_INTERVAL=2d' TENANT = mysql_tenant;

      ```

           - `appid` 表示腾讯云账户的 AppID，需要替换为实际的 AppID。
     - 系统租户为租户 `mysql_tenant` 配置归档目的端，归档介质为 S3 时，系统租户设置归档目的端并配置为 `tagging` 清理模式的示例如下：

      ```shell
      obclient [oceanbase]> ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=s3://oceanbase-test-bucket/backup/archive?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，采用用户业务优先模式，且每隔一天切分一个 Piece。

      ```shell
      obclient [oceanbase]> ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=file:///data/nfs/backup/archive BINDING=Optional PIECE_SWITCH_INTERVAL=1d';

      ```
     - 租户 `mysql_tenant` 为本租户配置归档目的端，归档介质为 OSS，归档文件的清理模式为 `tagging`。

      ```shell
      obclient [oceanbase]> ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=oss://oceanbase-test-bucket/backup/archive?host=xxx.aliyun-inc.com&access_id=xxx&access_key=xxx&delete_mode=tagging';

      ```
     - 租户 `mysql_tenant` 为本租户配置归档目的端，归档介质为 COS，归档文件的清理模式为 `delete`，采用归档优先模式，并且每隔 2 天切分一个 Piece。

      ```shell
      obclient [oceanbase]> ALTER SYSTEM SET LOG_ARCHIVE_DEST = 'LOCATION=cos://oceanbase-test-bucket/archive?host=cos.ap-xxx.myqcloud.com&access_id=xxx&access_key=xxx&appid=xxx&delete_mode=delete BINDING=Mandatory PIECE_SWITCH_INTERVAL=2d';

      ```

           - `appid` 表示腾讯云账户的 AppID，需要替换为实际的 AppID。
     - 租户 `mysql_tenant` 为本租户配置归档目的端，归档介质为 S3 时，设置归档目的端并配置为 `tagging` 清理模式的示例如下：

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

      ```

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

## 相关文档

- [ARCHIVELOG](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000821890)
 - [NOARCHIVELOG](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000821892)
 - [日志归档前准备](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000818798)

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线