Clean up backup references to their schedules when the schedules are deleted #12401

bernardodemarco · 2026-01-09T19:53:34Z

Description

Currently, the cloud.backups table references a backup schedule through the backup_schedule_id field. It is only populated when a backup is created from a schedule. For ad hoc backups, the field's value is kept as NULL.

Additionally, when backup schedules are deleted via the deleteBackupSchedule API, their corresponding entries are expunged from the DB. However, the backups' references to the schedules are not cleaned up and, thus, these references remain indefinitely in the cloud.backups table. It is important to highlight that, although the clean up process is not performed, it does not cause any bugs/side effects.

Therefore, this PR proposes to clean up such references before deleting backup schedules from the DB. The PR also cleans up some pieces of the code related with backup schedules, removing unused methods, moving methods' definitions to appropriate layers of the project and dropping the unused backup_interval_type column from the cloud.backups table (see #11223).

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Created a backup schedule and waited for some backups to be created from it
Deleted the backup schedule
Verified that the schedule's backups did not have references pointing to the schedule anymore

bernardodemarco · 2026-01-09T20:06:35Z

@blueorangutan package

blueorangutan · 2026-01-09T20:08:05Z

@bernardodemarco a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

codecov · 2026-01-09T20:11:15Z

Codecov Report

❌ Patch coverage is 0% with 24 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.59%. Comparing base (04875f1) to head (020f31a).

Files with missing lines	Patch %	Lines
...src/main/java/com/cloud/api/ApiResponseHelper.java	0.00%	14 Missing ⚠️
...e/cloudstack/backup/dao/BackupScheduleDaoImpl.java	0.00%	10 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.22   #12401   +/-   ##
=========================================
  Coverage     17.59%   17.59%           
- Complexity    15599    15600    +1     
=========================================
  Files          5910     5910           
  Lines        529733   529734    +1     
  Branches      64719    64720    +1     
=========================================
+ Hits          93215    93218    +3     
+ Misses       426025   426024    -1     
+ Partials      10493    10492    -1

Flag	Coverage Δ
uitests	`3.57% <ø> (ø)`
unittests	`18.66% <0.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

blueorangutan · 2026-01-09T21:23:42Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 16319

Copilot

Pull request overview

This PR addresses the cleanup of orphaned backup schedule references in the cloud.backups table. When backup schedules are deleted, backups created from those schedules retain references to non-existent schedule IDs. The PR implements proper cleanup by setting backup_schedule_id to NULL before deleting schedules, and also removes unused code and database columns.

Changes:

Implements cleanup of backup schedule references before schedule deletion
Removes unused backup_interval_type column from cloud.backups table
Refactors backup schedule response creation from DAO layer to API layer

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql	Adds SQL to drop unused `backup_interval_type` column
engine/schema/src/main/java/org/apache/cloudstack/backup/dao/BackupScheduleDaoImpl.java	Implements cleanup logic in `remove()` method and removes unused response builder
engine/schema/src/main/java/org/apache/cloudstack/backup/dao/BackupScheduleDao.java	Removes unused interface methods
server/src/main/java/com/cloud/api/ApiDBUtils.java	Removes delegation method for backup schedule response creation
server/src/main/java/com/cloud/api/ApiResponseHelper.java	Moves backup schedule response creation logic from DAO to API layer

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-12T07:28:29Z

engine/schema/src/main/java/org/apache/cloudstack/backup/dao/BackupScheduleDaoImpl.java

+    public boolean remove(Long id) {
+        String sql = "UPDATE backups SET backup_schedule_id = NULL WHERE backup_schedule_id = ?";
+        TransactionLegacy transaction = TransactionLegacy.currentTxn();
+        try {
+            PreparedStatement preparedStatement = transaction.prepareAutoCloseStatement(sql);
+            preparedStatement.setLong(1, id);
+            preparedStatement.executeUpdate();
+            return super.remove(id);
+        } catch (SQLException e) {
+            return false;
        }


The SQLException is caught but not logged or handled beyond returning false. This makes debugging difficult if the cleanup fails. Consider logging the exception with details about which schedule ID failed to be cleaned up.

Copilot · 2026-01-12T07:28:29Z

engine/schema/src/main/java/org/apache/cloudstack/backup/dao/BackupScheduleDaoImpl.java

+        try {
+            PreparedStatement preparedStatement = transaction.prepareAutoCloseStatement(sql);
+            preparedStatement.setLong(1, id);
+            preparedStatement.executeUpdate();
+            return super.remove(id);
+        } catch (SQLException e) {


If the backup reference cleanup succeeds but super.remove(id) fails, the backups will have NULL schedule references but the schedule will still exist. Consider wrapping both operations in a transaction to ensure atomicity, or handle the super.remove() failure case separately.

Suggested change

try {

PreparedStatement preparedStatement = transaction.prepareAutoCloseStatement(sql);

preparedStatement.setLong(1, id);

preparedStatement.executeUpdate();

return super.remove(id);

} catch (SQLException e) {

transaction.start();

try {

PreparedStatement preparedStatement = transaction.prepareAutoCloseStatement(sql);

preparedStatement.setLong(1, id);

preparedStatement.executeUpdate();

boolean removed = super.remove(id);

if (!removed) {

transaction.rollback();

return false;

}

transaction.commit();

return true;

} catch (SQLException e) {

transaction.rollback();

Copilot · 2026-01-12T07:28:30Z

engine/schema/src/main/resources/META-INF/db/schema-42200to42210.sql

 CALL `cloud_usage`.`IDEMPOTENT_ADD_COLUMN`('cloud_usage.usage_volume','vm_id', 'bigint UNSIGNED NULL COMMENT "VM ID associated with the volume usage"');
+
+-- Drops the unused "backup_interval_type" column of the "cloud.backups" table
+ALTER TABLE `cloud`.`backups` DROP COLUMN `backup_interval_type`;


The migration lacks a safety check (e.g., IF EXISTS or conditional check) to prevent failures if the column has already been dropped in a previous migration attempt. Consider using a procedure or adding a check to ensure idempotency.

Suggested change

ALTER TABLE `cloud`.`backups` DROP COLUMN `backup_interval_type`;

ALTER TABLE `cloud`.`backups` DROP COLUMN IF EXISTS `backup_interval_type`;

clean up backup schedule references after their deletion

5624336

bernardodemarco added this to the 4.22.1 milestone Jan 9, 2026

drop unused column

020f31a

DaanHoogland requested review from abh1sar and Copilot January 12, 2026 07:17

Copilot started reviewing on behalf of DaanHoogland January 12, 2026 07:18 View session

Copilot AI reviewed Jan 12, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Clean up backup references to their schedules when the schedules are deleted #12401

Clean up backup references to their schedules when the schedules are deleted #12401

bernardodemarco commented Jan 9, 2026 •

edited

Loading

Uh oh!

bernardodemarco commented Jan 9, 2026

Uh oh!

blueorangutan commented Jan 9, 2026

Uh oh!

codecov bot commented Jan 9, 2026 •

edited

Loading

Uh oh!

blueorangutan commented Jan 9, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Copilot AI Jan 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	ALTER TABLE `cloud`.`backups` DROP COLUMN `backup_interval_type`;
	ALTER TABLE `cloud`.`backups` DROP COLUMN IF EXISTS `backup_interval_type`;

Clean up backup references to their schedules when the schedules are deleted #12401

Are you sure you want to change the base?

Clean up backup references to their schedules when the schedules are deleted #12401

Conversation

bernardodemarco commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

bernardodemarco commented Jan 9, 2026

Uh oh!

blueorangutan commented Jan 9, 2026

Uh oh!

codecov bot commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Jan 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bernardodemarco commented Jan 9, 2026 •

edited

Loading

codecov bot commented Jan 9, 2026 •

edited

Loading