OceanBase AI Database supports backing up tenant-level and cluster-level parameters. These backup files provide configuration references for restoring the status of a cluster or tenant later.
Precautions
The cluster-level and tenant-level parameters backed up in this topic are provided only as configuration references. They are not restored to the cluster or tenant during physical restore.
Back up cluster-level parameters
Cluster-level parameters are not included in data backup. To back up cluster-level parameters, you must manually execute a command to back them up to a specified path. Only cluster-scope parameters with non-default values are backed up.
Limitations and considerations
Only the
systenant can back up cluster-level parameters. You cannot back up cluster-level parameters from a user tenant.When backing up cluster-level parameters, parameters such as
all_server_list,rootservice_list, anddebug_sync_timeoutare not backed up, regardless of whether their values are default or not.
Procedure
Log in to the
systenant of the cluster as therootuser.Execute the following SQL statement to back up the cluster-level parameters.
The sample SQL statement is as follows:
ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 'parameters_backup_path';In this statement,
parameters_backup_pathis the destination path for backing up cluster-level parameters, which must be specified by users. The path requirements are the same as those for the destination path of data backup. For more information, see Prepare for backup.Here is an example:
AWS S3Object storage compatible with the S3 protocolBack up the cluster-level parameters to the
s3://oceanbase-test-bucket/backup/data/cluster_parameters?host=s3.***.amazonaws.com&access_id=****&access_key=****&s3_region=****directory: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=****';Back up the cluster-level parameters to the
s3://oceanbase-test-bucket/backup/data/cluster_parameters?host=obs.****.myhuaweicloud.com&access_id=****&access_key=****directory of Huawei OBS:obclient> ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 's3://oceanbase-test-bucket/backup/data/cluster_parameters?host=obs.****.myhuaweicloud.com&access_id=****&access_key=****';Back up the cluster-level parameters to the
s3://oceanbase-test-bucket/backup/data/cluster_parameters?host=https://storage.googleapis.com&access_id=****&access_key=****directory of GCS:obclient> ALTER SYSTEM BACKUP CLUSTER PARAMETERS TO 's3://oceanbase-test-bucket/backup/data/cluster_parameters?host=https://storage.googleapis.com&access_id=****&access_key=****';Back up the cluster-level parameters to the
s3://oceanbase-test-bucket/backup/data/cluster_parameters?host=cos.ap-xxxx.myqcloud.com&access_id=***&access_key=***directory of COS: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=***';
Back up tenant-level parameters
For tenant-level parameters, when you Initiate a full data backup, the system automatically backs up the tenant-level parameters (tenant-scope parameters with non-default values) and the resource configurations of the tenant as part of the tenant data to the backup destination. No additional backup operation is required.
Notice
The external_kms_info and tde_method parameters contain sensitive encryption-related information. Therefore, regardless of whether their values are default, these parameters are not backed up.
What to do next
After the backup is successful, you can obtain the backup files of the tenant-level and cluster-level parameters from the destination path that you specified earlier. For more information about the directory structure of the backup parameters, see Overview of physical backup and restore.
After you obtain the backup files of the parameters, you can use the dump_backup command of the ob_admin tool to parse the files and obtain the configuration information.