PullRequest: 823 V4.0.0 merge :backup related docs

This commit is contained in:
obdev 2023-09-18 07:11:22 +00:00 committed by ob-robot
parent c30952ed34
commit 6a0ac799a9
2 changed files with 63 additions and 12 deletions

View File

@ -6,19 +6,27 @@
配置归档目的端的操作主要是设置 `LOCATION`、`PIECE_SWITCH_INTERVAL` 和 `BINDING` 属性。
1. 用户租户的租户管理员登录数据库。
1. `sys` 租户或用户租户的租户管理员登录数据库。
>**说明**
>
>MySQL 模式的管理员用户为 `root` 用户。
>MySQL 模式的管理员用户为 `root` 用户Oracle 模式的管理员用户为 `SYS` 用户
2. 设置归档目的端参数。
语句如下:
* 系统租户为指定租户配置归档目的端
```sql
obclient> ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=xxx [PIECE_SWITCH_INTERVAL=xxx] [BINDING=xxx]';
```
```sql
ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=xxx [PIECE_SWITCH_INTERVAL=xxx] [BINDING=xxx]' TENANT = tenant_name;
```
* 用户租户配置本租户的归档目的端
```sql
obclient> ALTER SYSTEM SET LOG_ARCHIVE_DEST='LOCATION=xxx [PIECE_SWITCH_INRERVAL=xxx] [BINDING=xxx]';
```
设置后,`sys` 租户和用户租户可分别通过 `CDB_OB_ARCHIVE_DEST``DBA_OB_ARCHIVE_DEST` 视图查看详细设置信息,具体操作请参见 [查看归档参数](8.view-parameters-of-log-archive.md)。
* 配置 `LOCATION` (必选)
@ -34,7 +42,7 @@
>
>* `LOCATION` 的值必须设置为绝对路径,保证 `OBServer``LOCATION` 具有读写权限 。
>
> 必须保证所有 OBServer 都挂载了同一个服务器的 NFS。同时为保证归档顺利进行务必使用本文档中建议的参数挂载 NFS。挂载 NFS 的具体操作,请参见 [部署 NFS 客户端](../2.deploy-nfs.md)。
> * 必须保证所有 OBServer 都挂载了同一个服务器的 NFS。同时为保证归档顺利进行务必使用本文档中建议的参数挂载 NFS。挂载 NFS 的具体操作,请参见 [部署 NFS 客户端](../2.deploy-nfs.md)。
当归档目的端的介质为 NFS 时,设置归档目的端的示例如下:
@ -100,14 +108,20 @@
## 注意事项
归档目的端配置成功后,不支持增量配置。
配置项 `LOG_ARCHIVE_DEST` 设置成功后,默认系统会在配置的目的端所在的目录下创建一个 `format` 文件,用于校验备份目的端的有效性信息,确保目的端内数据的完整性。故,在配置日志归档的目的端时,需要注意以下事项:
例如,假设 NFS 下归档路径 `/data/nfs/backup/archive` 配置的 `BINGDING` 属性为 `Mandatory` `PIECE_SWITCH_INTERVAL` 属性为 `1d`。若需要更新 `PIECE_SWITCH_INTERVAL``2d` ,但保留 `BINGDING` 属性的配置 `Mandatory` ,您仍然需要在命令中指定其他属性的值,否则未指定的属性将使用默认值。
* 如果 `format` 文件不存在,则要求配置的目的端所在的目录为空,配置项才能设置成功。否则,系统会报 `-9080` 的错误,提示 format 文件不存在。
* 如果 `format` 文件已存在,则要求 `format` 文件的内容检验通过,配置项才能设置成功。否则,系统会报 `-9081` 的错误,提示 format 文件不匹配, format 文件的内容校验主要是检查集群、租户与备份目的端类型等与当前操作的集群、租户及备份目的端类型是否匹配。
* 在执行备份任务时,如果 `format` 文件不存在或 `format` 文件校验不通过,任务会发起失败。
此外,归档目的端配置成功后,不支持增量配置。例如,假设 NFS 下归档路径 `/data/nfs/backup/archive` 配置的 `BINGDING` 属性为 `Mandatory` `PIECE_SWITCH_INTERVAL` 属性为 `1d`。若需要更新 `PIECE_SWITCH_INTERVAL``2d` ,但保留 `BINGDING` 属性的配置 `Mandatory` ,您仍然需要在命令中指定其他属性的值,否则未指定的属性将使用默认值。
您需要重新执行以下语句进行修改。
```sql
ALTER SYSTEM SET LOG_ARCHIVE_DEST = 'LOCATION=file:///data/nfs/backup/archive BINDING=Mandatory PIECE_SWITCH_INTERVAL=2d';
obclient> ALTER SYSTEM SET LOG_ARCHIVE_DEST = 'LOCATION=file:///data/nfs/backup/archive BINDING=Mandatory PIECE_SWITCH_INTERVAL=2d';
```
## 相关阅读

View File

@ -4,11 +4,27 @@
## 配置备份目的端
1. 用户租户的租户管理员登录数据库。
1. `sys` 租户或用户租户的租户管理员登录数据库。
>**说明**
>
>MySQL 模式的管理员用户为 `root` 用户Oracle 模式的管理员用户为 `SYS` 用户。
2. 配置备份目的端。
目前OceanBase 数据库支持 NFS 、阿里云 OSS 作为备份目的端。
目前OceanBase 数据库支持 NFS、阿里云 OSS 作为备份目的端。
* 系统租户为指定租户配置备份目的端
```sql
ALTER SYSTEM SET DATA_BACKUP_DEST = 'data_backup_path' TENANT = mysql_tenant;
```
* 用户租户配置本租户的备份目的端
```sql
ALTER SYSTEM SET DATA_BACKUP_DEST = 'data_backup_path';
```
例如:
@ -51,3 +67,24 @@
```sql
obclient> 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';
```
3. 配置成功后,`SYS` 租户可通过视图 `CDB_OB_BACKUP_PARAMETER` 查看当前集群中各租户的备份路径等信息。
```sql
obclient> SELECT * FROM oceanbase.CDB_OB_BACKUP_PARAMETER\G
*********************** 1. row ********************
TENANT_ID: 1002
NAME: data_backup_dest
VALUE: file:///data/nfs/backup/data
1 rows in set
```
## 注意事项及说明
配置项 `data_backup_dest` 设置成功后,默认系统会在配置的目的端所在的目录下创建一个 `format` 文件,用于校验备份目的端的有效性信息,确保目的端内数据的完整性。故,在配置数据备份的目的端 `data_backup_dest` 时,需要注意以下事项:
* 如果 `format` 文件不存在,则要求配置的目的端所在的目录为空,配置项才能设置成功。否则,系统会报 `-9080` 的错误,提示 format 文件不存在。
* 如果 `format` 文件已存在,则要求 `format` 文件的内容检验通过,配置项才能设置成功。否则,系统会报 `-9081` 的错误,提示 format 文件不匹配, format 文件的内容校验主要是检查集群、租户与备份目的端类型等与当前操作的集群、租户及备份目的端类型是否匹配。
* 在执行备份任务时,如果 `format` 文件不存在或 `format` 文件校验不通过,任务会发起失败。