ucampostgresvro 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

ucampostgresvro/DBA.py

@@ -1,4 +1,5 @@
 import logging
+from datetime import datetime
 from typing import Optional
 
 import psycopg2
@@ -150,6 +151,57 @@ class DB:
             LOG.info(f"INFO: {table_name} information is fetched successfully")
             return self.cursor.fetchall()
 
+    def get_vrauser_by_id(
+        self,
+        user_id: int,
+        table_name: str = DEFAULT_TABLES.get("user"),
+    ) -> any:
+        """Retreive the information from the vrauser table.
+
+        Args:
+            user_id (int): primary key of user to fetch information.
+            table_name (str): table name of the user.
+
+        Raises:
+            DbException: Raise exception in case of retrieving information
+
+        Returns:
+            any: retreive the data from the vrauser database.
+        """
+        with self.connection:
+            try:
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where id = '{user_id}';"
+                )
+                LOG.info(f"INFO: {table_name} information is fetched successfully")
+                return self.cursor.fetchone()
+            except Exception as e:
+                LOG.error(
+                    f"Error: Unable to fetch user id from table '{table_name}': {e}"
+                )
+                raise DbException(
+                    f"Error: Unable to fetch user id from table '{table_name}': {e}"
+                )
+
+    def get_vrauser_primary_key(
+        self,
+        crsid: Optional[str] = None,
+        table_name: str = DEFAULT_TABLES.get("user"),
+    ) -> any:
+        """Retreive the information from the vrauser table.
+
+        Args:
+            crsid (Optional[str], optional): CRSID need to be fetched. Defaults to None.
+            table_name (str): table name of the user.
+
+        Returns:
+            any: retreive the data from the vrauser database.
+        """
+        with self.connection:
+            self.cursor.execute(f"SELECT * FROM {table_name} where crsid = '{crsid}';")
+            LOG.info(f"INFO: {table_name} information is fetched successfully")
+            return self.cursor.fetchone()[0]
+
     def insert_deployment_id(
         self, deployment_id: str, table_name: str = DEFAULT_TABLES.get("deploymentid")
     ) -> bool:
@@ -268,6 +320,60 @@ class DB:
             LOG.info("INFO: deployment ID information is fetched successfully")
             return self.cursor.fetchall()
 
+    def get_deployment_id_by_id(
+        self,
+        deployment_id: int,
+        table_name: str = DEFAULT_TABLES.get("deploymentid"),
+    ) -> any:
+        """Retreive the information from the deployment table.
+
+        Args:
+            deployment_id (int): primary key of the Deployment ID need to be fetched.
+            table_name (str, optional): table name of the deploymentid. Defaults to DEFAULT_TABLES.get("deploymentid").
+
+        Raises:
+            DbException: Raise exception in case of retrieving information
+
+        Returns:
+            any: Retreive the data from the Deployment ID database.
+        """
+        with self.connection:
+            try:
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where id = '{deployment_id}';"
+                )
+                LOG.info("INFO: deployment ID information is fetched successfully")
+                return self.cursor.fetchone()
+            except Exception as e:
+                LOG.error(
+                    f"Error: Unable to fetch deployment id from table '{table_name}': {e}"
+                )
+                raise DbException(
+                    f"Error: Unable to fetch deployment id from table '{table_name}': {e}"
+                )
+
+    def get_deployment_id_primary_key(
+        self,
+        deployment_id: str,
+        table_name: str = DEFAULT_TABLES.get("deploymentid"),
+    ) -> any:
+        """Retreive the primary key from the deployment table.
+
+        Args:
+            deployment_id (str): Deployment ID need to be fetched.
+            table_name (str): table name of the deploymentid.
+
+        Returns:
+            any: Retreive the data from the Deployment ID database.
+        """
+        with self.connection:
+            if deployment_id:
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where deploymentID = '{deployment_id}';"
+                )
+            LOG.info("INFO: deployment ID information is fetched successfully")
+            return self.cursor.fetchone()[0]
+
     def insert_project(
         self,
         project_number: str,
@@ -281,7 +387,7 @@ class DB:
             project_number (str): payment order information.
             paid_by (int): primary key of the vrauser.
             amount (float): amount paid for the purchase.
-            table_name (str): table name of the purchaseOrder.
+            table_name (str): table name of the project.
 
         Raises:
             DbException: Exception for the provided inputs.
@@ -315,7 +421,7 @@ class DB:
 
     def update_project(
         self,
-        old_project_number: str,
+        project_id: int,
         new_project_number: str,
         new_paid_by: int,
         new_amount: float,
@@ -324,11 +430,11 @@ class DB:
         """Updation of the the project detail in project table
 
         Args:
-            old_project_number (str): old payment order information.
-            new_project_number (str): new payment order information to replace old payment order.
+            project_id (int): project id to be updated.
+            new_project_number (str): new project information to replace old project.
             new_paid_by (int): new primary key of the vrauser.
-            new_amount (float): new amount paid for the purchase.
-            table_name (str): table name of the purchaseOrder.
+            new_amount (float): new amount paid for the project.
+            table_name (str): table name of the project.
 
         Returns:
             bool: True for the success and False for the failure.
@@ -338,24 +444,24 @@ class DB:
                 self.cursor.execute(
                     f"UPDATE {table_name} SET \
                     project_number ='{new_project_number}', paid_by='{new_paid_by}', amount='{new_amount}' \
-                    WHERE project_number='{old_project_number}';"
+                    WHERE id='{project_id}';"
                 )
                 LOG.info(
-                    f"INFO: Updation of the project {old_project_number} has been peformed successfully"
+                    f"INFO: Updation of the project {project_id} has been peformed successfully"
                 )
                 return True
             except Exception as e:
-                LOG.error(f"Error: purchaseOrder Updating in table {table_name} : {e}")
+                LOG.error(f"Error: Project Updating in table {table_name} : {e}")
                 return False
 
     def remove_project(
-        self, project_number: str, table_name: str = DEFAULT_TABLES.get("proj")
+        self, project_id: int, table_name: str = DEFAULT_TABLES.get("proj")
     ) -> bool:
         """Removal of the project.
 
         Args:
-            project_number (str): project which need to be removed.
-            table_name (str): table name of the purchaseOrder.
+            project_id (int): project id which need to be removed.
+            table_name (str): table name of the project.
 
         Returns:
             bool: True for the success and False for the failure.
@@ -363,44 +469,92 @@ class DB:
         with self.connection:
             try:
                 self.cursor.execute(
-                    f"DELETE from {table_name} WHERE project_number='{project_number}';"
+                    f"DELETE from {table_name} WHERE id='{project_id}';"
                 )
                 LOG.info(
-                    f"INFO: Removing of the project '{project_number}' has been performed successfully."
+                    f"INFO: Removing of the project '{project_id}' has been performed successfully."
                 )
                 return True
             except Exception as e:
-                LOG.error(
-                    f"Error: purchaseOrder removing from table '{table_name}': {e}"
-                )
+                LOG.error(f"Error: project removing from table '{table_name}': {e}")
                 raise DbException(
-                    f"Error: purchaseOrder removing from table '{table_name}': {e}"
+                    f"Error: project removing from table '{table_name}': {e}"
                 )
 
     def get_project(
         self,
-        project_number: Optional[str] = None,
+        project: Optional[int] = None,
         table_name: str = DEFAULT_TABLES.get("proj"),
     ) -> any:
         """Retreive the information from the project table.
 
         Args:
-            project_number (Optional[str], optional): project which need to be fetched. Defaults to None.
-            table_name (str): table name of the purchaseOrder.
+            project (Optional[int], optional): project which need to be fetched. Defaults to None.
+            table_name (str): table name of the project.
 
         Returns:
             any: Retreive the data from the project database.
         """
         with self.connection:
-            if project_number:
+            if project:
                 self.cursor.execute(
-                    f"SELECT * FROM {table_name} where project_number = '{project_number}';"
+                    f"SELECT * FROM {table_name} where project_number = '{project}';"
                 )
             else:
                 self.cursor.execute(f"SELECT * FROM {table_name};")
             LOG.info("INFO: project information has been fetched successfully.")
             return self.cursor.fetchall()
 
+    def get_project_by_id(
+        self,
+        project_id: int,
+        table_name: str = DEFAULT_TABLES.get("proj"),
+    ) -> any:
+        """Retreive the information from the project table.
+
+        Args:
+            project_id (Optional[int], optional): project which need to be fetched. Defaults to None.
+            table_name (str): table name of the project.
+
+        Returns:
+            any: Retreive the data from the project database.
+        """
+        with self.connection:
+            self.cursor.execute(
+                f"SELECT * FROM {table_name} where id = '{project_id}';"
+            )
+            LOG.info("INFO: project information has been fetched successfully.")
+            return self.cursor.fetchone()
+
+    def get_project_primary_key(
+        self,
+        project: str,
+        datestmp: datetime = None,
+        table_name: str = DEFAULT_TABLES.get("proj"),
+    ) -> any:
+        """Retreive the primary key of the project from the project table.
+
+        Args:
+            project (str): project which need to be fetched.
+            datestmp (date, optional): date for which the value to be retrieved. Defaults to None.
+            table_name (str, optional): table name of the project. Defaults to DEFAULT_TABLES.get("proj").
+
+        Returns:
+            any: Retreive the data from the project database.
+        """
+        with self.connection:
+            if datestmp:
+                LOG.info(f"Date query : {datestmp}")
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where project_number = '{project}' and date >= '{datestmp}';"
+                )
+            else:
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where project_number = '{project}';"
+                )
+            LOG.info("INFO: project information has been fetched successfully.")
+            return self.cursor.fetchone()[0]
+
     def insert_grant(
         self,
         grant_number: str,
@@ -446,7 +600,7 @@ class DB:
 
     def update_grant(
         self,
-        old_grant: str,
+        grant_id: int,
         new_grant: str,
         new_paid_by: int,
         new_amount: float,
@@ -455,7 +609,7 @@ class DB:
         """ "Updation of the the grant detail in grant table
 
         Args:
-            old_grant (str): old grant information.
+            grant_id (id): grant id to be updated.
             new_grant (str): new grant information to replace old grant.
             new_paid_by (int): new primary key of the vrauser.
             new_amount (float): new amount paid for the purchase.
@@ -468,25 +622,25 @@ class DB:
             try:
                 self.cursor.execute(
                     f"UPDATE {table_name} SET grant_number ='{new_grant}', paid_by='{new_paid_by}', \
-                    amount='{new_amount}' WHERE grant_number='{old_grant}';"
+                    amount='{new_amount}' WHERE id='{grant_id}';"
                 )
                 LOG.info(
-                    f"INFO: Updation of the grant {old_grant} has been performed successfully."
+                    f"INFO: Updation of the grant {grant_id} has been performed successfully."
                 )
                 return True
             except Exception as e:
                 LOG.error(
-                    f"Error: grant Updating of '{old_grant}' in table '{table_name}': {e}"
+                    f"Error: grant Updating of '{grant_id}' in table '{table_name}': {e}"
                 )
                 return False
 
     def remove_grant(
-        self, grant_number: str, table_name: str = DEFAULT_TABLES.get("grant")
+        self, grant_id: int, table_name: str = DEFAULT_TABLES.get("grant")
     ) -> bool:
         """Removal of the grant.
 
         Args:
-            grant_number (str): grant number which need to be replaced.
+            grant_id (int): grant number which need to be replaced.
             table_name (str): table name of the grant.
 
         Returns:
@@ -494,30 +648,28 @@ class DB:
         """
         with self.connection:
             try:
-                self.cursor.execute(
-                    f"DELETE from {table_name} WHERE grant_number='{grant_number}';"
-                )
+                self.cursor.execute(f"DELETE from {table_name} WHERE id='{grant_id}';")
                 LOG.info(
-                    f"INFO: Removal of the grant {grant_number} has been performed successfully."
+                    f"INFO: Removal of the grant {grant_id} has been performed successfully."
                 )
                 return True
             except Exception as e:
                 LOG.error(
-                    f"Error: Removal of grant {grant_number} from table {table_name}: {e}"
+                    f"Error: Removal of grant {grant_id} from table {table_name}: {e}"
                 )
                 raise DbException(
-                    f"Error: Removal of grant {grant_number} from table {table_name}: {e}"
+                    f"Error: Removal of grant {grant_id} from table {table_name}: {e}"
                 )
 
     def get_grant(
         self,
-        grant_number: str | None = None,
+        grant_number: int | None = None,
         table_name: str = DEFAULT_TABLES.get("grant"),
     ) -> any:
         """Retreive the information from the grant table.
 
         Args:
-            grant_number (str | None, optional): grant which need to be fetched. Defaults to None.
+            grant_number (int | None, optional): primary key of the grant which need to be fetched. Defaults to None.
             table_name (str): table name of the grant.
 
         Returns:
@@ -533,6 +685,54 @@ class DB:
             LOG.info("INFO: grant information has been fetched successfully.")
             return self.cursor.fetchall()
 
+    def get_grant_by_id(
+        self,
+        grant_id: int,
+        table_name: str = DEFAULT_TABLES.get("grant"),
+    ) -> any:
+        """Retreive the information from the grant table.
+
+        Args:
+            grant_id (int | None, optional): primary key of the grant which need to be fetched. Defaults to None.
+            table_name (str): table name of the grant.
+
+        Returns:
+            any: Retreive the data from the grant database.
+        """
+        with self.connection:
+            self.cursor.execute(f"SELECT * FROM {table_name} where id = '{grant_id}';")
+            LOG.info("INFO: grant information has been fetched successfully.")
+            return self.cursor.fetchone()
+
+    def get_grant_primary_key(
+        self,
+        grant_number: str,
+        datestmp: datetime = None,
+        table_name: str = DEFAULT_TABLES.get("grant"),
+    ) -> any:
+        """Retreive the information from the grant table.
+
+        Args:
+            grant_number (str | None, optional): grant which need to be fetched. Defaults to None.
+            datestmp (datetime, optional): date for which the value to be retrieved. Defaults to None.
+            table_name (str): table name of the grant.
+
+        Returns:
+            any: Retreive the data from the grant database.
+        """
+        with self.connection:
+            if datestmp:
+                LOG.info(f"Date query : {datestmp}")
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where grant_number = '{grant_number}' and date >= '{datestmp}';"
+                )
+            else:
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where grant_number = '{grant_number}';"
+                )
+            LOG.info("INFO: grant information has been fetched successfully.")
+            return self.cursor.fetchone()[0]
+
     def insert_costing(
         self,
         deployment_id: int,
@@ -601,23 +801,21 @@ class DB:
 
     def update_costing(
         self,
-        deployment_id: int,
-        typee: str,
-        old_grant_id: Optional[int] = None,
-        old_project_id: Optional[int] = None,
-        grant_id: Optional[int] = None,
-        project_id: Optional[int] = None,
+        old_costing_id: int,
+        new_deployment_id: int,
+        new_typee: str,
+        new_grant_id: Optional[int] = None,
+        new_project_id: Optional[int] = None,
         table_name: str = DEFAULT_TABLES.get("costing"),
     ) -> bool:
         """Updation of the costing database entry.
 
         Args:
-            deployment_id (int): primary key of the deployment id.
-            typee (str): type of the license.
-            old_grant_id (Optional[int], optional): primary key of the old grant id. Defaults to None.
-            old_project_id (Optional[int], optional): primary key of the old payment order. Defaults to None.
-            grant_id (Optional[int], optional): primary key of the grant id. Defaults to None.
-            project_id (Optional[int], optional): primary key of the grant id. Defaults to None.
+            old_costing_id (int): primary key of the costing id.
+            new_deployment_id (int): primary key of the deployment id.
+            new_typee (str): type of the license.
+            new_grant_id (Optional[int], optional): primary key of the grant id. Defaults to None.
+            new_project_id (Optional[int], optional): primary key of the project id. Defaults to None.
             table_name (str): table name of the costing.
 
         Raises:
@@ -626,67 +824,40 @@ class DB:
         Returns:
             bool: True for the success and False for the failure.
         """
-        if old_project_id and old_grant_id:
-            LOG.info(
-                "Error: Please do not provide deployment_id. type, and, (project_id/ grant_id) for costing"
-            )
+        if new_grant_id and new_project_id:
             raise DbException(
-                "Error: Please do not provide deployment_id. type, and, (project_id/ grant_id) for costing"
+                f"Error: Specify either grant_id or project_id for updating the table {table_name}"
             )
-        elif old_project_id:
-            with self.connection:
-                try:
-                    grant_id = "NULL" if not grant_id else f"'{grant_id}'"
-                    project_id = "NULL" if not project_id else f"'{project_id}'"
-                    self.cursor.execute(
-                        f"UPDATE {table_name} SET \
-                        deployment_id ='{deployment_id}', type='{typee}', project_id={project_id}, \
-                        grant_id={grant_id} WHERE project_id='{old_project_id}';"
-                    )
-                    LOG.info(
-                        "INFO: updation of the costing has been performed successfully."
-                    )
-                    return True
-                except Exception as e:
-                    LOG.error(
-                        f"Error: Updation of costing has failed in table '{table_name}': \n {e}"
-                    )
-                    return False
-        elif old_grant_id:
-            with self.connection:
-                try:
-                    grant_id = "NULL" if not grant_id else f"'{grant_id}'"
-                    project_id = "NULL" if not project_id else f"'{project_id}'"
-                    self.cursor.execute(
-                        f"UPDATE {table_name} SET deployment_id ='{deployment_id}', type='{typee}', \
-                        grant_id={grant_id}, project_id={project_id} WHERE grant_id='{old_grant_id}';"
-                    )
-                    LOG.info(
-                        "INFO: updation of the costing has been performed successfully."
-                    )
-                    return True
-                except Exception as e:
-                    LOG.error(f"Error: Updation of costing has failed: \n {e}")
-                    return False
-        else:
-            LOG.error("Error: updation of the costing has been failed")
-            return False
+        with self.connection:
+            try:
+                grant_id = "NULL" if not new_grant_id else f"'{new_grant_id}'"
+                project_id = "NULL" if not new_project_id else f"'{new_project_id}'"
+                self.cursor.execute(
+                    f"UPDATE {table_name} SET \
+                    deployment_id ='{new_deployment_id}', type='{new_typee}', project_id={project_id}, \
+                    grant_id={grant_id} WHERE id='{old_costing_id}';"
+                )
+                LOG.info(
+                    "INFO: updation of the costing has been performed successfully."
+                )
+                return True
+            except Exception as e:
+                LOG.error(
+                    f"Error: Updation of costing has failed in table '{table_name}': \n {e}"
+                )
+                raise DbException(
+                    f"Error: Updation of costing has failed in table '{table_name}'"
+                )
 
     def remove_costing(
         self,
-        deployment_id: int,
-        typee: str,
-        project_id: Optional[int] = None,
-        grant_id: Optional[int] = None,
+        costing_id: int,
         table_name: str = DEFAULT_TABLES.get("costing"),
     ) -> bool:
         """Removal of the costing detail from costing database.
 
         Args:
-            deployment_id (int): primary key of the deployment id.
-            typee (str): type of the license.
-            project_id (Optional[int], optional): primary key of the payment order. Defaults to None.
-            grant_id (Optional[int], optional): primary key of the grant id. Defaults to None.
+            costing_id (int): primary key of the costing id.
             table_name (str): table name of the costing.
 
         Raises:
@@ -696,49 +867,20 @@ class DB:
             bool: True for the success and False for the failure.
         """
         with self.connection:
-            if grant_id and project_id:
-                LOG.error(
-                    "Error: Please do not provide both project_id and grant_id for costing"
+            try:
+                self.cursor.execute(
+                    f"DELETE from {table_name} WHERE id = '{costing_id}';"
                 )
-                raise DbException(
-                    "Error: Please do not provide both project_id and grant_id for costing"
+                LOG.info(
+                    "INFO: Removing of the costing has been performed successfully."
                 )
-            elif deployment_id and grant_id:
-                try:
-                    self.cursor.execute(
-                        f"DELETE from {table_name} WHERE deployment_id = '{deployment_id}' and type = '{typee}' \
-                        and grant_id = '{grant_id}';"
-                    )
-                    LOG.info(
-                        "INFO: Removing of the costing has been performed successfully."
-                    )
-                    return True
-                except Exception as e:
-                    LOG.error(
-                        f"Error: Removing of costing has failed in table {table_name}: \n {e}"
-                    )
-                    return False
-            elif deployment_id and project_id:
-                try:
-                    self.cursor.execute(
-                        f"DELETE from {table_name} WHERE deployment_id = '{deployment_id}' and type = '{typee}' \
-                        and project_id = '{project_id}';"
-                    )
-                    LOG.info(
-                        "INFO: Removing of the costing has been performed successfully."
-                    )
-                    return True
-                except Exception as e:
-                    LOG.error(
-                        f"Error: Removing of costing has failed in table '{table_name}': \n {e}"
-                    )
-                    return False
-            else:
+                return True
+            except Exception as e:
                 LOG.error(
-                    "Error: Please provide correct deployment_id, type, and, (project_id/grant_id) for costing"
+                    f"Error: Removing of costing has failed in table {table_name}: \n {e}"
                 )
                 raise DbException(
-                    "Error: Please provide correct deployment_id, type, and, (project_id/grant_id) for costing"
+                    f"Error: Removing of costing has failed in table {table_name}: \n {e}"
                 )
 
     def get_costing(
@@ -785,6 +927,73 @@ class DB:
             LOG.info("INFO: costing information has been performed successfully")
             return self.cursor.fetchall()
 
+    def get_costing_by_id(
+        self,
+        costing_id: int,
+        table_name: str = DEFAULT_TABLES.get("costing"),
+    ) -> any:
+        """Retreive the information from the costing table.
+
+        Args:
+            costing_id (int): primary key of the costing id.
+            table_name (str): table name of the costing.
+
+        Returns:
+            any: Retreive the data from the costing database.
+        """
+        with self.connection:
+            try:
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where id = '{costing_id}';"
+                )
+                LOG.info("INFO: costing information has been performed successfully")
+                return self.cursor.fetchone()
+            except Exception as e:
+                LOG.error(
+                    f"Error: Unable to fetch costing id from table '{table_name}': {e}"
+                )
+                raise DbException(
+                    f"Error: Unable to fetch costing id from table '{table_name}': {e}"
+                )
+
+    def get_costing_primary_key(
+        self,
+        deployment_id: int,
+        typee: str,
+        project_id: Optional[int] = None,
+        grant_id: Optional[int] = None,
+        table_name: str = DEFAULT_TABLES.get("costing"),
+    ) -> any:
+        """Retreive the primary key from the costing table.
+
+        Args:
+            deployment_id (int): primary key of the deployment id.
+            typee (str): type of the license.
+            project_id (Optional[int], optional): primary key of the payment order. Defaults to None.
+            grant_id (Optional[int], optional): primary key of the grant id. Defaults to None.
+            table_name (str): table name of the costing.
+
+        Returns:
+            any: Retreive the data from the costing database.
+        """
+        with self.connection:
+            if deployment_id and project_id and typee:
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where deployment_id = '{deployment_id}' and type = '{typee}' \
+                    and project_id = '{project_id}';"
+                )
+            elif deployment_id and grant_id and typee:
+                self.cursor.execute(
+                    f"SELECT * FROM {table_name} where deployment_id = '{deployment_id}' and type = '{typee}' \
+                    and grant_id = '{grant_id}';"
+                )
+            else:
+                raise DbException(
+                    "please provide project_id or grant_id along with deplyment_id and type"
+                )
+            LOG.info("INFO: costing information has been performed successfully")
+            return self.cursor.fetchone()[0]
+
     def closedb(self) -> None:
         """
         To close the databse connection.