Backup Management

UClickhouse provides data backup and recovery functionality. You can perform periodic and manual backups of clusters by accessing the UClickhouse Console . All cluster data is backed up to the US3 storage.

Note: Data backup only supports the MergeTree series engines.

Enable Backup and Recovery Functionality

By default, the backup and recovery functionality is not enabled. When entering the “Backup and Recovery Management” page for the first time, you need to bind the US3 storage space.

After binding the US3 storage space, you will enter the backup list page.

Please ensure that the US3 token must have permissions for uploading, downloading, deleting, and listing files in the storage space and has a sufficiently long validity period.

Backup List

On the “Cluster List” page, click “Details” -> “Backup and Recovery Management.”

The list page displays two modules: backup storage location and backup list.

The backup storage location includes information such as the US3 token and storage space. The backup list includes backup ID, backup name, type, backup size, backup start time, backup end time, status, etc.

Modify US3 Storage Space

Note: After modifying the US3 space, existing backup records will be cleared. The backup files in the US3 space will not be automatically deleted and need to be manually removed. Refer to the US3 Tools.

On the “Cluster List” page, click “Details” -> “Backup and Recovery Management,” and you will see the backup storage location module.

Click “Modify” to display the “Modify US3” dialog box:

Please ensure that the US3 token must have permissions for uploading, downloading, deleting, and listing files in the storage space and has a sufficiently long validity period.

Enable Automatic Backup Strategy

On the “Cluster List” page, click “Details” -> “Backup and Recovery Management,” and you will see the backup module, including the “Automatic Backup Strategy” button.

Click “Automatic Backup Strategy” to display the “Automatic Backup Strategy” dialog box, which is off by default.

Once “Automatic Backup Strategy” is enabled, it will display information on backup frequency, backup time, and retention period. By default, backups are performed daily, and you can choose according to your needs. Backup data can be retained for up to two years, and you can select the retention duration based on actual needs.

During the execution time window, if a backup fails, it will be retried. No retries will occur outside the execution time window.

Note: Data backup will consume node resources. It is recommended to schedule the backup to occur during periods of low business activity.

Manual Backup

On the “Cluster List” page, click “Details” -> “Backup and Recovery Management,” and you will see the backup module, including the “Manual Backup” button.

Click “Manual Backup” and fill in the backup name to perform a manual backup.

1. During data backup, node resources will be consumed. It is recommended to perform manual backups during periods of low business activity.
2. Manual backups do not expire automatically.
3. Only one can execute at the same time, either manual or automatic backup.