Merge pull request #497 from conrad-blucher-institute/496-create-a-da…

…tabase-migration-for-the-water-and-air-temperature-measurements-from-noaatandc-south-bird-island

496 create a database migration for the water and air temperature measurements from noaatandc south bird island

tools/DatabaseMigration/2_8/2_8_DatabaseMigration.py

@@ -0,0 +1,103 @@
+# -*- coding: utf-8 -*-
+#2_8_DatabaseMigration.py
+#----------------------------------
+# Created By: Anointiyae Beasley
+# Created Date: 12/19/2024
+# Version 1.0
+#----------------------------------
+"""This is a database migration script that will initialize version
+    2.8 of the database. The change from version 2.7 to 2.8 will add
+    rows to the locations reference table and the location
+    mapping reference table for Cold Stunning air and water temperature Measurements. 
+ """ 
+#----------------------------------
+# 
+#
+#Imports
+from DatabaseMigration.IDatabaseMigration import IDatabaseMigration
+from DatabaseMigration.databaseMigrationUtility import KeywordType, DatabaseDeletionHelper
+from sqlalchemy import Engine, MetaData, Table, delete, select
+from sqlalchemy.dialects.postgresql import insert
+import csv
+
+#Constants
+CSV_FILE_PATHS = './tools/DatabaseMigration/2_8/init_data'
+
+
+class Migrator(IDatabaseMigration):
+
+    def update(self, databaseEngine: Engine) -> bool:
+        """This function updates the database to version 2.8 which adds rows to the locations reference 
+           table and the location mapping reference table.
+
+           :param databaseEngine: Engine - the engine of the database we are connecting to (semaphore)
+           :return: bool indicating successful update
+        """
+        # Setting engine
+        self.__engine = databaseEngine
+
+        # Reflect the tables from the database that we want to add data too
+        metadata = MetaData()
+        metadata.reflect(bind=databaseEngine)
+
+        ref_dataLocation = metadata.tables['ref_dataLocation']
+        ref_dataLocation_dataSource_mapping = metadata.tables['dataLocation_dataSource_mapping']
+
+        # Insert the data based off of csv files
+        self.insert_ref_data(self.readInitCSV('sbiLocations.csv'), ref_dataLocation)
+        self.insert_ref_data(self.readInitCSV('sbiMapping.csv'), ref_dataLocation_dataSource_mapping)
+
+        return True
+
+    def readInitCSV(self, csvFileName: str) -> list:
+        """This function reads in a CSV file with the data needed for the initialization 
+            of the database
+            :param csvFileName: str - CSV file name
+            
+            :return: list of dictionaries
+        """
+        csvFilePath = f'{CSV_FILE_PATHS}/{csvFileName}'
+        dictionaryList = []
+        with open(csvFilePath, mode = 'r') as infile:
+            csvDict = csv.DictReader(infile)
+            for dictionary in csvDict:
+                dictionaryList.append(dictionary)
+
+        return dictionaryList
+
+    def insert_ref_data(self, rows: list[dict], table: Table) -> list[tuple]:
+        """This method inserts reference rows
+            :param rows: A list of dictionaries. The dict can be found in NOTE 1
+            :return Series - SQLALCHEMY tupleish rows
+            NOTE:: {"code": None, "displayName": None, "notes": None, "latitude": None, "longitude": None}
+        """
+        with self.__engine.connect() as conn:
+            cursor = conn.execute(insert(table)
+                                  .returning(table)
+                                  .values(rows)
+                                  )
+            result = cursor.fetchall()
+            conn.commit()
+            return result
+
+    def rollback(self, databaseEngine: Engine) -> bool:
+        """This function rolls the database back to version 2.7 which involves removing the changes 
+           associated with version 2.8.
+
+           :param databaseEngine: Engine - the engine of the database we are connecting to (semaphore)
+           :return: bool indicating successful update
+        """
+        # Note that we only explicitly include the locations csv here
+        # because a part of the deep_delete protocol of the data locations
+        # table is to delete the location from the mapping table. 
+        fileNames = ['sbiLocations.csv']
+        fileTypes = [KeywordType.DATA_LOCATION]
+
+        # Using the utility helper class to delete any data dependent on the rows added in the 2.7 Migration
+        helper = DatabaseDeletionHelper(databaseEngine)
+
+        for file, type in zip(fileNames, fileTypes):
+            for rowDict in self.readInitCSV(file):
+                helper.deep_delete_keyword(rowDict["code"], type)
+
+        return True

tools/DatabaseMigration/2_8/init_data/sbiLocations.csv

@@ -0,0 +1,2 @@
+code,displayName,notes,latitude,longitude
+SBI,South Bird Island,NOAATANDC,27.485,-97.318333

tools/DatabaseMigration/2_8/init_data/sbiMapping.csv

@@ -0,0 +1,2 @@
+dataLocationCode,dataSourceCode,dataSourceLocationCode,priorityOrder
+"SBI","NOAATANDC","8776139",0

tools/DatabaseMigration/target_version.json

@@ -1,4 +1,4 @@
 {
-    "Target Version" : "2.7",
-    "Description" : "Updating output.modelName to a varchar(50)."
+    "Target Version" : "2.8",
+    "Description" : "NOAATANDC South Bird Island location mapping"
 }