Updated IDEMPOTENT_ADD_FOREIGN_KEY procedure and fixed some foreign keys to keep proper names

Author: harikrishna-patnala

engine/schema/src/main/java/com/cloud/upgrade/dao/DatabaseAccessObject.java

@@ -26,6 +26,17 @@ public class DatabaseAccessObject {
 
     private static Logger s_logger = Logger.getLogger(DatabaseAccessObject.class);
 
+    public void addForeignKey(Connection conn, String tableName, String tableColumn, String foreignTableName, String foreignColumnName) {
+        String addForeignKeyStmt = String.format("CALL `cloud`.`IDEMPOTENT_ADD_FOREIGN_KEY`('%s', '%s', '%s', '%s')", tableName, tableColumn, foreignTableName, foreignColumnName);
+        try(PreparedStatement pstmt = conn.prepareStatement(addForeignKeyStmt);)
+        {
+            pstmt.executeUpdate();
+            s_logger.debug(String.format("Foreign key is added successfully from the table %s", tableName));
+        } catch (SQLException e) {
+            s_logger.error("Ignored SQL Exception when trying to add foreign key on table "  + tableName + " exception: " + e.getMessage());
+        }
+    }
+
     public void dropKey(Connection conn, String tableName, String key, boolean isForeignKey)
     {
         String alter_sql_str;

engine/schema/src/main/java/com/cloud/upgrade/dao/DbUpgradeUtils.java

@@ -23,7 +23,10 @@ public class DbUpgradeUtils {
 
     private static DatabaseAccessObject dao = new DatabaseAccessObject();
 
-    public static void dropKeysIfExist(Connection conn, String tableName, List<String> keys, boolean isForeignKey) {
+    public static void addForeignKey(Connection conn, String tableName, String tableColumn, String foreignTableName, String foreignColumnName) {
+        dao.addForeignKey(conn, tableName, tableColumn, foreignTableName, foreignColumnName);
+    }
+   public static void dropKeysIfExist(Connection conn, String tableName, List<String> keys, boolean isForeignKey) {
         for (String key : keys) {
             dao.dropKey(conn, tableName, key, isForeignKey);
         }

engine/schema/src/main/java/com/cloud/upgrade/dao/Upgrade41800to41810.java

@@ -22,6 +22,8 @@
 
 import java.io.InputStream;
 import java.sql.Connection;
+import java.util.ArrayList;
+import java.util.List;
 
 public class Upgrade41800to41810 implements DbUpgrade, DbUpgradeSystemVmTemplate {
     final static Logger LOG = Logger.getLogger(Upgrade41800to41810.class);
@@ -55,6 +57,7 @@ public InputStream[] getPrepareScripts() {
 
     @Override
     public void performDataMigration(Connection conn) {
+        fixForeignKeyNames(conn);
     }
 
     @Override
@@ -82,4 +85,30 @@ public void updateSystemVmTemplates(Connection conn) {
             throw new CloudRuntimeException("Failed to find / register SystemVM template(s)");
         }
     }
+
+    private void fixForeignKeyNames(Connection conn) {
+        //Alter foreign key name for user_vm table from fk_user_data_id to fk_user_vm__user_data_id (if exists)
+        List<String> keys = new ArrayList<String>();
+        keys.add("fk_user_data_id");
+        keys.add("fk_user_vm__user_data_id");
+        DbUpgradeUtils.dropKeysIfExist(conn, "cloud.user_vm", keys, true);
+        DbUpgradeUtils.dropKeysIfExist(conn, "cloud.user_vm", keys, false);
+        DbUpgradeUtils.addForeignKey(conn, "user_vm", "user_data_id", "user_data", "id");
+
+        //Alter foreign key name for vm_template table from fk_user_data_id to fk_vm_template__user_data_id (if exists)
+        keys = new ArrayList<>();
+        keys.add("fk_user_data_id");
+        keys.add("fk_vm_template__user_data_id");
+        DbUpgradeUtils.dropKeysIfExist(conn, "cloud.vm_template", keys, true);
+        DbUpgradeUtils.dropKeysIfExist(conn, "cloud.vm_template", keys, false);
+        DbUpgradeUtils.addForeignKey(conn, "vm_template", "user_data_id", "user_data", "id");
+
+        //Alter foreign key name for volumes table from fk_passphrase_id to fk_volumes__passphrase_id (if exists)
+        keys = new ArrayList<>();
+        keys.add("fk_passphrase_id");
+        keys.add("fk_volumes__passphrase_id");
+        DbUpgradeUtils.dropKeysIfExist(conn, "cloud.volumes", keys, true);
+        DbUpgradeUtils.dropKeysIfExist(conn, "cloud.volumes", keys, false);
+        DbUpgradeUtils.addForeignKey(conn, "volumes", "passphrase_id","passphrase", "id");
+    }
 }

engine/schema/src/main/resources/META-INF/db/schema-41800to41810.sql

@@ -19,3 +19,12 @@
 -- Schema upgrade from 4.18.0.0 to 4.18.1.0
 --;
 
+DROP PROCEDURE IF EXISTS `cloud`.`IDEMPOTENT_ADD_FOREIGN_KEY`;
+CREATE PROCEDURE `cloud`.`IDEMPOTENT_ADD_FOREIGN_KEY` (
+    IN in_table_name VARCHAR(200),
+    IN in_table_column VARCHAR(200),
+    IN in_foreign_table_name VARCHAR(200),
+    IN in_foreign_column_name VARCHAR(200)
+)
+BEGIN
+    DECLARE CONTINUE HANDLER FOR 1005,1826 BEGIN END; SET @ddl = CONCAT('ALTER TABLE cloud.', in_table_name); SET @ddl = CONCAT(@ddl, ' ', ' ADD CONSTRAINT '); SET @ddl = CONCAT(@ddl, 'fk_', in_table_name, '__', in_foreign_table_name, '_', in_foreign_column_name); SET @ddl = CONCAT(@ddl, ' FOREIGN KEY (', in_table_column, ')'); SET @ddl = CONCAT(@ddl, ' REFERENCES ', in_foreign_table_name, '(', in_foreign_column_name, ')'); PREPARE stmt FROM @ddl; EXECUTE stmt; DEALLOCATE PREPARE stmt; END;