exam-manager.app.dal.result_dal
===============================

.. py:module:: exam-manager.app.dal.result_dal

.. autoapi-nested-parse::

   Data acess layer (DAL) between fastapi endpoint and sql database.



Functions
---------

.. autoapisummary::

   exam-manager.app.dal.result_dal.add_result_db
   exam-manager.app.dal.result_dal.get_result_db
   exam-manager.app.dal.result_dal.get_all_results_db
   exam-manager.app.dal.result_dal.update_result_db
   exam-manager.app.dal.result_dal.delete_result_db


Module Contents
---------------

.. py:function:: add_result_db(payload: scanhub_libraries.models.BaseResult) -> app.db.postgres.Result
   :async:


   Add new result to database.

   Parameters
   ----------
   payload
       Result pydantic base model

   Returns
   -------
       Database orm model of created result


.. py:function:: get_result_db(result_id: uuid.UUID) -> app.db.postgres.Result | None
   :async:


   Get result by id.

   Parameters
   ----------
   result_id
       Id of the requested result

   Returns
   -------
       Database orm model with data of requested result


.. py:function:: get_all_results_db(task_id: uuid.UUID) -> list[app.db.postgres.Result]
   :async:


   Get a list of all results assigned to a certain task.

   Parameters
   ----------
   task_id
       Id of the parent task entry, results are assigned to

   Returns
   -------
       List of result data base orm models


.. py:function:: update_result_db(result_id: uuid.UUID, payload: scanhub_libraries.models.BaseResult) -> app.db.postgres.Result | None
   :async:


   Update existing result in database.

   Parameters
   ----------
   result_id
       Id of the result to be updateed
   payload
       Result pydantic base model with data to be updated

   Returns
   -------
       Resuld database orm model of updated result


.. py:function:: delete_result_db(result_id: uuid.UUID) -> bool
   :async:


   Delete result by id.

   Parameters
   ----------
   result_id
       Id of the result to be deleted

   Returns
   -------
       Success of deletion